-
Notifications
You must be signed in to change notification settings - Fork 28
add embedded cluster cli docs reference #3429
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.
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
Conversation
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
sudo ./<app-slug> admin-console reset-password [flags] | ||
``` | ||
|
||
## Commands |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
could consider calling this subcommands since these are subcommands of the admin-console command
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sounds good
## Usage | ||
|
||
```bash | ||
sudo ./<app-slug> join print-command [flags] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is a subcommand of join, so given the pattern elsewhere, this shouldn't be its own page but should be listed as a subcommand of join.
but then note that if we go that route, join is itself a command but it has subcommands. so it's not like admin-console
where the top-level command does nothing and you need to provide a subcommand.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right, I was thinking print-command might benefit from its own page since it has it's own use case (which does break the pattern).
I think if we do want to stick to the pattern and nest it under join, it'll still be fine since it can be described as a subcommand. However, if it has unique flags or something that you'd rather keep separate so as to not introduce confusion, we can leave it as its own page
https://deploy-preview-3429--replicated-docs-upgrade.netlify.app/reference/embedded-cluster-admin-console