chore: Doc update for em default value and warning if dpf is not used.#3656
chore: Doc update for em default value and warning if dpf is not used.#3656abvarshney-nv wants to merge 2 commits into
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
WalkthroughThe NICo DPF manual reformats its introductory expectations note and documents ChangesNICo DPF documentation
Estimated code review effort: 1 (Trivial) | ~2 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-3656.docs.buildwithfern.com/infra-controller |
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/manuals/dpf.md`:
- Around line 34-38: Update the second note in the DPF documentation to scope
the “default provisioning strategy” claim to configurations where [dpf].enabled
is true, while preserving the existing warning behavior for hosts not using DPF.
🪄 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: 8cadccd9-60e3-4d6d-9c33-2c1af99fe9fc
📒 Files selected for processing (1)
docs/manuals/dpf.md
polarweasel
left a comment
There was a problem hiding this comment.
Just a couple little changes to your couple little changes :)
| > **Note**: | ||
| > | ||
| > 1. NICo expects DPF to be installed and configured on the same Kubernetes cluster where NICo (the controller) runs. | ||
| > 2. DPF is the default provisioning strategy. If any host is not using it, a warning will be displayed. | ||
| > |
There was a problem hiding this comment.
Let's use Fern's component here. Check the Coderabbit commentary too, in case it's relevant...
| > **Note**: | |
| > | |
| > 1. NICo expects DPF to be installed and configured on the same Kubernetes cluster where NICo (the controller) runs. | |
| > 2. DPF is the default provisioning strategy. If any host is not using it, a warning will be displayed. | |
| > | |
| <Note title="Notes"> | |
| 1. NICo expects DPF to be installed and configured on the same Kubernetes cluster where NICo (the controller) runs. | |
| 2. DPF is the default provisioning strategy. If any host is not using it, a warning will be displayed. | |
| </Note> | |
| > **Important**: this is **not a merge**. Any expected-machine row that is | ||
| > not present in the file is **deleted**. Each entry is then re-created via | ||
| > the same path as `add`, so any entry whose `dpf_enabled` is omitted is | ||
| > re-inserted with `dpf_enabled = false`. | ||
| > re-inserted with `dpf_enabled = true`. |
There was a problem hiding this comment.
I have no doubt there are more of these, but gotta start somewhere :)
| > **Important**: this is **not a merge**. Any expected-machine row that is | |
| > not present in the file is **deleted**. Each entry is then re-created via | |
| > the same path as `add`, so any entry whose `dpf_enabled` is omitted is | |
| > re-inserted with `dpf_enabled = false`. | |
| > re-inserted with `dpf_enabled = true`. | |
| <Warning> | |
| This is not a merge. Any expected-machine row that is not present in the file is **deleted**. Each entry is then re-created using the same path as `add`, so any entry whose `dpf_enabled` is omitted is re-inserted with `def_enabled = true`. | |
| </Warning> |
Doc change for the commits:
Related issues
Type of Change
Breaking Changes
Testing
Additional Notes