Update docs #598
Merged
Update docs #598
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds the help information that it will show up in your deploy history since that is an important aspect of it.
glinton
suggested changes
Oct 16, 2017
commands/info.go
Outdated
| @@ -16,7 +16,7 @@ var ( | |||
|
|
|||
| // InfoCmd ... | |||
| InfoCmd = &cobra.Command{ | |||
| Use: "info", | |||
| Use: "info [local | dry-run | remote-alias]", | |||
There was a problem hiding this comment.
I believe the remote-alias portion of this has yet to be implemented
commands/login.go
Outdated
| @@ -15,7 +15,11 @@ var ( | |||
| LoginCmd = &cobra.Command{ | |||
| Use: "login", | |||
| Short: "Authenticate your nanobox client with your nanobox.io account.", | |||
| Long: ``, | |||
| Long: ` | |||
| Authenticate with your nanobox account by passing the username and password in or using the following environment variables: | |||
There was a problem hiding this comment.
I suggest removing the leading spaces on these 3 lines, so the output isn't pushed out so much.
commands/remote.go
Outdated
| @@ -27,7 +27,7 @@ remote, live applications created with Nanobox. | |||
|
|
|||
| // RemoteAddCmd ... | |||
| RemoteAddCmd = &cobra.Command{ | |||
| Use: "add", | |||
| Use: "add <team-name>/<app-name> [remote-alias]", | |||
There was a problem hiding this comment.
Since team-name is technically optional, can you update this to be [team-name/]<app-name> [remote-alias]
|
@glinton should be good to go now |
glinton
approved these changes
Oct 16, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Helps with #503