docs: finish DaemonSet casing pass and bump a stale aicrd tag - #2339
Conversation
|
🌿 Preview your docs: https://nvidia-preview-docs-sweep-followup-nits.docs.buildwithfern.com/aicr |
Follow-up to the review on NVIDIA#2335, which flagged two non-blocking items that PR left behind. F1 — NVIDIA#2335 cased the "GPU DaemonSets" table header in cli-reference.md but left the same section's Note and bullet reading "GPU daemonsets", creating a within-section mismatch that was not there before. Both are now cased. Re-sweeping the file for the same class turned up two more prose instances in the DRA kubelet plugin section ("restarts the ... daemonset", "the daemonset restart"); those are fixed here too so the file does not need a third pass. Left lowercase deliberately: `--ignore-daemonsets` (a kubectl flag) and "CRD/namespace/daemonset create" (an RBAC resource-name list), where lowercase is correct. F2 — the rolling-update example in kubernetes-deployment.md pinned the server image to aicrd:v0.8.0, roughly eleven releases stale. NVIDIA#2335's version sweep matched `aicr:`/`aicr_`/`aicr@` and never matched `aicrd:`, so the server image slipped through. Bumped to v0.19.0. A broader re-sweep confirms this was the only stale aicrd tag in docs/. Untouched: the `aicrd:v1.0.0` placeholder in .github/actions/README.md (a parameter example, not a version claim) and the v0.8.12 SBOM sample in supply-chain-verification.md, which is one internally coherent captured attestation across five sites. Signed-off-by: Yuan Chen <yuanchen97@gmail.com>
8098b0c to
dc01045
Compare
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Enterprise Run ID: 📒 Files selected for processing (2)
Included review availability: Your plan provides up to 12 included reviews per hour; 10 remain after this review. 📝 WalkthroughWalkthroughThe documentation updates change the Kubernetes rolling-update example to image tag Estimated code review effort: 1 (Trivial) | ~3 minutes Merge Risk: ⚪ Minimal · up to This is a localized documentation-only update correcting Kubernetes terminology and refreshing a copy-pasteable image tag; no actionable merge-blocking risk remains beyond normal checks and review. Suggested reviewers: 🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Summary
Fixes the two 🟡 minor findings from the review on #2335: a
DaemonSetcasing mismatch that #2335 introduced, and a staleaicrdimage tag its version sweep missed.Motivation / Context
F1 — casing mismatch #2335 introduced. That PR cased the
GPU DaemonSetstable header incli-reference.md(L1520) but left the same section's Note (L1529) and bullet (L1547) readingGPU daemonsets. A casing sweep that creates a within-section mismatch is worse than one that skips the section, so this should not sit.While fixing it I re-swept the file for the same class and found two more prose instances in the DRA kubelet plugin section (L2632, L2634). Those are fixed here too, so the file does not need a third pass.
Left lowercase on purpose, because lowercase is correct there:
--ignore-daemonsets(L2639) — akubectlflagCRD/namespace/daemonset create(L92) — an RBAC resource-name listF2 — stale server image tag missed by the version sweep. The rolling-update example in
kubernetes-deployment.md(L612) pinnedghcr.io/nvidia/aicrdtov0.8.0, roughly eleven releases old, in a copy-pasteable command. #2335 normalized client tags using a pattern matchingaicr:/aicr_/aicr@— which never matchesaicrd:, so the server image slipped through. Bumped tov0.19.0.A broader re-sweep confirms that was the only stale
aicrd:tag indocs/.Fixes: N/A
Related: #2335 (this PR completes its review follow-ups)
Type of Change
Component(s) Affected
cmd/aicr,pkg/cli)cmd/aicrd,pkg/server)pkg/recipe)pkg/bundler,pkg/component/*)pkg/collector,pkg/snapshotter)pkg/validator)pkg/errors,pkg/k8s)docs/,examples/)Implementation Notes
Deliberately not included, to keep this scoped to the two review findings:
docs/integrator/components/nodewright.mdL52 says "provide the configuration via configmaps" — same lowercase-kind class, but a different file that neither docs: doc sweep for stale references, casing, and index gaps #2335 nor its review touched. Noting it rather than folding it in.agent-deployment.md(apps/daemonsets,serviceaccounts,configmaps,roles, rolebindings) is correctly lowercase — those are API resource names, not kind references.aicrd:v1.0.0placeholder in.github/actions/README.mdis a parameter example, not a version claim.v0.8.12SBOM sample insupply-chain-verification.mdis one internally coherent captured attestation across five sites; the review already refuted bumping it.Testing
Docs-only; no Go, YAML schema, or build inputs touched, so tests, e2e, and Go lint cannot regress from this diff.
Also re-ran a repo-wide sweep for lowercase Kubernetes kind names in prose (excluding code fences, inline code, and URLs) to confirm this pass is complete for
cli-reference.md.Risk Assessment
Rollout notes: N/A — prose casing and one example image tag.
Checklist
make testwith-race) — N/A, no Go changesmake lint) — doc-lint subset run, see Testinggit commit -S)