docs(admin-cli): document rack state-history command#3676
Open
sydneyl-nvidia wants to merge 3 commits into
Open
docs(admin-cli): document rack state-history command#3676sydneyl-nvidia wants to merge 3 commits into
rack state-history command#3676sydneyl-nvidia wants to merge 3 commits into
Conversation
## Description Adds the missing operator reference page for the `nico-admin-cli rack state-history <RACK_ID>` command. - New page `docs/manuals/nico-admin-cli/commands/rack/rack-state-history.md`, placed alongside the other `rack` subcommand pages (`rack-show.md`, `rack-profile-show.md`, etc.). - Structured to match the sibling pages: NAME, SYNOPSIS, DESCRIPTION, OPTIONS (including the global `--extended` and `--sort-by` flags inherited from `cli_options.rs`), Examples, and the See-also footer. - Adds a `state-history` row to the Subcommands table in `rack.md` so the new page is discoverable from the parent command doc. ## Type of Change - [ ] **Add** - New feature or capability - [ ] **Change** - Changes in existing functionality - [ ] **Fix** - Bug fixes - [ ] **Remove** - Removed features or deprecated functionality - [X] **Internal** - Internal changes (refactoring, tests, docs, etc.) ## Related Issues (Optional) ## Breaking Changes - [ ] This PR contains breaking changes ## Testing - [ ] Unit tests added/updated - [ ] Integration tests added/updated - [ ] Manual testing performed - [X] No testing required (docs, internal refactor, etc.) ## Additional Notes Content verified against the command's clap definition (`crates/admin-cli/src/rack/state_history/args.rs` and `rack/mod.rs`): required `RACK_ID` positional, `about = "Show rack state history"`, and the example mirrors the sibling docs' UUID style.
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
Summary by CodeRabbit
WalkthroughAdds a manual page for ChangesRack state history documentation
Estimated code review effort: 1 (Trivial) | ~3 minutes Possibly related issues
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
🌿 Preview your docs: https://nvidia-preview-pull-request-3676.docs.buildwithfern.com/infra-controller |
🔍 Container Scan SummaryNo Grype artifacts were found to aggregate. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/manuals/nico-admin-cli/commands/rack/rack-state-history.md`:
- Around line 23-25: Correct the grammar in the extended-output description by
changing “This used by measured boot” to “This is used by measured boot,” while
preserving the surrounding explanation.
- Around line 11-12: Update the `nico-admin-cli rack state-history` synopsis to
show the required argument for `--sort-by`, using `--sort-by <SORT_BY>` while
preserving the existing options and `RACK_ID` operand.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 524572c0-15d1-4ab1-a117-75e3f36f76ee
📒 Files selected for processing (2)
docs/manuals/nico-admin-cli/commands/rack/rack-state-history.mddocs/manuals/nico-admin-cli/commands/rack/rack.md
The global `--sort-by` option is inherited by every subcommand via clap's `global = true`, but `rack state-history` never reads `config.sort_by` and always emits records in chronological order. Document this in the command's DESCRIPTION and next to the inherited `--sort-by` option so operators aren't misled into thinking the flag reorders the output.
Signed-off-by: Syd Logan <sydneyl@nvidia.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
Adds the missing operator reference page for the
nico-admin-cli rack state-history <RACK_ID>command.docs/manuals/nico-admin-cli/commands/rack/rack-state-history.md, placed alongside the otherracksubcommand pages (rack-show.md,rack-profile-show.md, etc.).--extendedand--sort-byflags inherited fromcli_options.rs), Examples, and the See-also footer.state-historyrow to the Subcommands table inrack.mdso the new page is discoverable from the parent command doc.Type of Change
Related Issues (Optional)
Breaking Changes
Testing
Additional Notes
Content verified against the command's clap definition (
crates/admin-cli/src/rack/state_history/args.rsandrack/mod.rs): requiredRACK_IDpositional,about = "Show rack state history", and the example mirrors the sibling docs' UUID style.