Skip to content

docs: finish DaemonSet casing pass and bump a stale aicrd tag - #2339

Merged
mchmarny merged 1 commit into
NVIDIA:mainfrom
yuanchen8911:docs/sweep-followup-nits
Aug 22, 2026
Merged

docs: finish DaemonSet casing pass and bump a stale aicrd tag#2339
mchmarny merged 1 commit into
NVIDIA:mainfrom
yuanchen8911:docs/sweep-followup-nits

Conversation

@yuanchen8911

@yuanchen8911 yuanchen8911 commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

This is a follow-up to #2335. That PR (the release-prep documentation sweep) was approved with two non-blocking minor findings, which it left unfixed. This PR fixes both. It is docs-only: 2 files, +5/−5.

Summary

Fixes the two 🟡 minor findings from the review on #2335: a DaemonSet casing mismatch that #2335 introduced, and a stale aicrd image tag its version sweep missed.

Motivation / Context

F1 — casing mismatch #2335 introduced. That PR cased the GPU DaemonSets table header in cli-reference.md (L1520) but left the same section's Note (L1529) and bullet (L1547) reading GPU 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) — a kubectl flag
  • CRD/namespace/daemonset create (L92) — an RBAC resource-name list

F2 — stale server image tag missed by the version sweep. The rolling-update example in kubernetes-deployment.md (L612) pinned ghcr.io/nvidia/aicrd to v0.8.0, roughly eleven releases old, in a copy-pasteable command. #2335 normalized client tags using a pattern matching aicr: / aicr_ / aicr@ — which never matches aicrd:, so the server image slipped through. Bumped to v0.19.0.

A broader re-sweep confirms that was the only stale aicrd: tag in docs/.

Fixes: N/A
Related: #2335 (this PR completes its review follow-ups)

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Refactoring (no functional changes)
  • Build/CI/tooling

Component(s) Affected

  • CLI (cmd/aicr, pkg/cli)
  • API server (cmd/aicrd, pkg/server)
  • Recipe engine / data (pkg/recipe)
  • Bundlers (pkg/bundler, pkg/component/*)
  • Collectors / snapshotter (pkg/collector, pkg/snapshotter)
  • Validator (pkg/validator)
  • Core libraries (pkg/errors, pkg/k8s)
  • Docs/examples (docs/, examples/)
  • Other: ____________

Implementation Notes

Deliberately not included, to keep this scoped to the two review findings:

  • docs/integrator/components/nodewright.md L52 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.
  • The RBAC permission list in agent-deployment.md (apps/daemonsets, serviceaccounts, configmaps, roles, rolebindings) is correctly lowercase — those are API resource names, not kind references.
  • The aicrd:v1.0.0 placeholder in .github/actions/README.md is a parameter example, not a version claim.
  • The v0.8.12 SBOM sample in supply-chain-verification.md is 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.

./tools/check-docs-filenames    # OK: all doc filenames follow kebab-case convention
./tools/check-docs-mdx          # OK: all doc files are MDX-safe
./tools/check-docs-mdx-parse    # OK: 54 doc file(s) parse as MDX
./tools/check-agents-sync       # OK: AGENTS.md is in sync with .claude/CLAUDE.md
git diff --check                # clean

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

  • Low — Isolated change, well-tested, easy to revert
  • Medium — Touches multiple components or has broader impact
  • High — Breaking change, affects critical paths, or complex rollout

Rollout notes: N/A — prose casing and one example image tag.

Checklist

  • Tests pass locally (make test with -race) — N/A, no Go changes
  • Linter passes (make lint) — doc-lint subset run, see Testing
  • I did not skip/disable tests to make CI green
  • I added/updated tests for new functionality — N/A, documentation only
  • I updated docs if user-facing behavior changed — N/A, no behavior change
  • Changes follow existing patterns in the codebase
  • Commits are cryptographically signed (git commit -S)

@yuanchen8911 yuanchen8911 added area/docs theme/community Contributor onboarding, docs, and external engagement labels Aug 21, 2026
@yuanchen8911
yuanchen8911 requested a review from njhensley August 21, 2026 22:20
@github-actions

Copy link
Copy Markdown
Contributor

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>
@yuanchen8911
yuanchen8911 marked this pull request as ready for review August 21, 2026 22:34
@yuanchen8911
yuanchen8911 force-pushed the docs/sweep-followup-nits branch from 8098b0c to dc01045 Compare August 21, 2026 22:34
@yuanchen8911
yuanchen8911 requested a review from a team as a code owner August 21, 2026 22:34
@coderabbitai

coderabbitai Bot commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: a49e708b-8ca0-4a44-bfa3-76bf3a121d85

📥 Commits

Reviewing files that changed from the base of the PR and between 06d2cbb and dc01045.

📒 Files selected for processing (2)
  • docs/integrator/kubernetes-deployment.md
  • docs/user/cli-reference.md

Included review availability: Your plan provides up to 12 included reviews per hour; 10 remain after this review.


📝 Walkthrough

Walkthrough

The documentation updates change the Kubernetes rolling-update example to image tag v0.19.0. They also standardize capitalization of “DaemonSet” and “DaemonSets” in the CLI reference. Command semantics, scheduling behavior, and recovery procedures remain unchanged.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Merge Risk: ⚪ Minimal · up to dc010

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: njhensley

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly summarizes both documentation changes: completing DaemonSet casing updates and correcting a stale aicrd image tag.
Description check ✅ Passed The description accurately explains the two documentation fixes, their scope, validation steps, and lack of functional changes.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@yuanchen8911
yuanchen8911 requested a review from mchmarny August 22, 2026 00:06

@mchmarny mchmarny left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approve: no findings against dc01045. All exact-head checks passed or were intentionally skipped by path filters.

@mchmarny
mchmarny merged commit 709b179 into NVIDIA:main Aug 22, 2026
36 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs size/S theme/community Contributor onboarding, docs, and external engagement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants