docs: add one-line expected machine add example#2627
Conversation
|
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)
🚧 Files skipped from review as they are similar to previous changes (1)
Summary by CodeRabbit
WalkthroughDocumentation update to ChangesIngesting Hosts Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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/provisioning/ingesting-hosts.md`:
- Around line 146-150: The command in the bash example uses an incorrect binary
name and is missing the mandatory API URL flag. Replace carbide-admin-cli with
the correct binary name nico-admin-cli and add the required -c <api-url> flag
immediately after the binary name, before the expected-machine (or em)
subcommand. Refer to the canonical examples in
crates/admin-cli/src/expected_machines/add/args.rs to verify the correct syntax
structure where the API URL flag is positioned after the binary name.
🪄 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: 90e00ee3-8906-4c7e-9ffc-f36cf733c5ea
📒 Files selected for processing (1)
docs/provisioning/ingesting-hosts.md
Signed-off-by: Jake Bloom <jbloom@nvidia.com>
776d5a6 to
335cda5
Compare
Signed-off-by: Jake Bloom <jbloom@nvidia.com>
|
This is fine to add, but just as an FYI we auto-generate usage examples now - https://github.com/NVIDIA/infra-controller/blob/main/docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-add.md |
|
/ok to test b726037 |
docs: add one-line expected machine add example
Summary
docs/provisioning/ingesting-hosts.mdin the "Add Expected Machines Table" section.carbide-admin-cli expected-machine addexample for adding a single expected machine.expected_machines.json/em replace-allworkflow documented for full-table loads.expected-machine addis for individual hosts andreplace-allis for defining the complete table from JSON.Testing