Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Toolbox documentation #63

Merged
merged 8 commits into from
Oct 23, 2018
Merged

Toolbox documentation #63

merged 8 commits into from
Oct 23, 2018

Conversation

eguzki
Copy link
Member

@eguzki eguzki commented Oct 23, 2018 •
edited
Loading

  • New documentation for update service command
  • Improve documentation for copy and import commands.
  • Remove unnecessary help flag
  • Add TOC to README

@eguzki eguzki requested a review from mikz October 23, 2018 12:16
@mikz mikz requested a review from a team October 23, 2018 12:23
mikz
mikz approved these changes Oct 23, 2018
View reviewed changes
Copy link
Contributor

@mikz mikz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking pretty good. Just two minor nitpicks.

README.md Outdated
Example:

```shell
$ 3scale update service -s https://234239874598743@3scaleinstance_source.com -d https://2342342342342@3scaleinstance_destination.com 3 2
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is better to stick using example.com as an example domain. You can use it's subdomains too.

README.md Outdated
3scale CLI tools to manage your API from the terminal.

COMMANDS
copy 3scale copy super command
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is a "super command" ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

parent of a subcommand.

Intention was to make it clear that by itself does nothing. There are subcommands behind it.

Will change to something more meaningful

@eguzki
Copy link
Member Author

eguzki commented Oct 23, 2018

I am adding a TOC, can be handy when doc becomes too long.

@eguzki eguzki merged commit 6885829 into master Oct 23, 2018
@eguzki eguzki deleted the doc/update-service branch October 23, 2018 13:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mikz mikz mikz approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@eguzki @mikz