Skip to content

Conversation

@paigecalvert
Copy link
Contributor

@paigecalvert paigecalvert commented Aug 6, 2025

@netlify
Copy link

netlify bot commented Aug 6, 2025

Deploy Preview for replicated-docs-upgrade ready!

Name Link
🔨 Latest commit a3af4a6
🔍 Latest deploy log https://app.netlify.com/projects/replicated-docs-upgrade/deploys/6894c26db67c6e0009de82b0
😎 Deploy Preview https://deploy-preview-3429--replicated-docs-upgrade.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify
Copy link

netlify bot commented Aug 6, 2025

Deploy Preview for replicated-docs ready!

Name Link
🔨 Latest commit a3af4a6
🔍 Latest deploy log https://app.netlify.com/projects/replicated-docs/deploys/6894c26d60144f000834a80e
😎 Deploy Preview https://deploy-preview-3429--replicated-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@replicated-ci replicated-ci added type::docs Improvements or additions to documentation type::feature labels Aug 6, 2025
@paigecalvert paigecalvert marked this pull request as ready for review August 6, 2025 18:05
@paigecalvert paigecalvert requested a review from a team as a code owner August 6, 2025 18:05
sudo ./<app-slug> admin-console reset-password [flags]
```

## Commands
Copy link
Member

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

Copy link
Contributor Author

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]
Copy link
Member

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.

Copy link
Contributor Author

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

@paigecalvert paigecalvert merged commit 55a7a6c into main Aug 8, 2025
5 checks passed
@paigecalvert paigecalvert deleted the 127558 branch August 8, 2025 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type::docs Improvements or additions to documentation type::feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants