feat: improved docs for new hardware support#3282
Conversation
Signed-off-by: Krish Dandiwala <kdandiwala@nvidia.com>
|
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 due to trivial changes (1)
Summary by CodeRabbit
WalkthroughThe hardware support guide is reorganized with updated startup guidance, revised scenario instructions, expanded testing procedures, and new reference and contribution sections for new hardware work. ChangesHardware Support Guide Update
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
🔍 Container Scan SummaryNo Grype artifacts were found to aggregate. |
|
🌿 Preview your docs: https://nvidia-preview-pull-request-3282.docs.buildwithfern.com/infra-controller |
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/development/new_hardware_support.md`:
- Around line 128-130: The guidance should point to the real cross-crate mapping
hook instead of a nonexistent `From<RedfishVendor>` impl. Update the docs to
reference `bmc_vendor(...)` in `crates/redfish/src/libredfish/conv.rs` as the
extension point for wiring libredfish vendor detection into `BMCVendor`, and
keep the other enum/string parsing mentions aligned with that actual conversion
path.
- Around line 311-314: The markdown link in the “Testing with nico-admin-cli
redfish” reference is split awkwardly between the link label and the inline code
text, so update the affected sentence in the lifecycle validation list to make
the entire section name part of a single link. Keep the existing anchor target,
but rewrite the reference near the “Complete the live-BMC validation…” item so
the full “Testing with nico-admin-cli redfish” text is rendered as one clickable
link.
🪄 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: 7ba040eb-a0bf-48b2-ba26-1f28dd0ea4e7
📒 Files selected for processing (1)
docs/development/new_hardware_support.md
Signed-off-by: Krish Dandiwala <kdandiwala@nvidia.com>
Signed-off-by: Krish Dandiwala <kdandiwala@nvidia.com>
This PR improves the new hardware support guide by documenting:
libredfishandnv-redfishcontribution flowbmc-explorer-cliandnico-admin-clinv-redfishas the default exploration pathRelated issues
#3281
Type of Change
Breaking Changes
Testing
Additional Notes