Update Replicated CLI docs for v0.88.1 #2984
Conversation
replicated-ci
added
type::docs
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| items: [ | ||
| 'reference/replicated-cli-installing', | ||
| // This list is generated. Do not edit. | ||
| 'reference/replicated', |
There was a problem hiding this comment.
^ The description in this new overview topic is not great
Manage your Commercial Software Distribution Lifecycle using Replicated
Synopsis
The 'replicated' CLI allows Replicated customers (vendors) to manage their Commercial Software Distribution Lifecycle (CSDL) using the Replicated API.
We probably don't need much of a definition of the CLI TBH, but something like "the CLI for the Vendor Portal" would prob suffice
| @@ -0,0 +1,52 @@ | |||
| # replicated app rm | |||
There was a problem hiding this comment.
^ could be helpful to list delete as an alias?
There was a problem hiding this comment.
^ same goes for channel rm
There was a problem hiding this comment.
This function right now does not add aliases to the output: https://github.com/spf13/cobra/blob/6c3c1163c6df19860515103199e880122ba49e80/doc/md_docs.go#L57-L117
Which is inconsistent with Go template they use for rendering help on command line: https://github.com/spf13/cobra/blob/6c3c1163c6df19860515103199e880122ba49e80/command.go#L558-L559
We can fix that.
|
|
||
| ### Synopsis | ||
|
|
||
| Enable semantic versioning for the CHANNEL_ID. |
There was a problem hiding this comment.
Enable semantic versioning for the CHANNEL_ID.
I think this would be better as "Enable semantic versioning for the channel.", rather than CHANNEL_ID
There was a problem hiding this comment.
same comment for disable-semver above
There was a problem hiding this comment.
Once doc generating PR is merged, this can be addressed
| Create a new application in your Replicated account. | ||
|
|
||
| This command allows you to initialize a new application that can be distributed | ||
| and managed using the KOTS platform. When you create a new app, it will be set up |
There was a problem hiding this comment.
...application that can be distributed
and managed using the KOTS platform. ...
^ not sure what the KOTS platform means here
There was a problem hiding this comment.
Once doc generating PR is merged, this can be addressed
There was a problem hiding this comment.
Note: Paige to add redirect for this page to app rm in the netlify toml before merging
| @@ -1,22 +0,0 @@ | |||
| import Help from "../partials/replicated-cli/_help.mdx" | |||
There was a problem hiding this comment.
^ looks like each of the completion topics got deleted in favor of a single completion topic that lists bash, fish, powershell, zsh as options
I'm fine with this as long as there wasn't anything that you all think it would be helpful to go into more detail about in individual topics for each option
There was a problem hiding this comment.
Indeed... They will need to be defined as separate subcommands in order to be in separate topics, similar to registry add commands
|
Will close this PR once all comments are resolved. Changes to address content comments need to be made in the Replicated CLI project. |
|
Closing. The updated cli docs were added with #2987 |
No description provided.