Skip to content

docs: update Helm chart documentation URLs after nav slug changes - #1797

Merged
glody merged 1 commit into
docs-nvbug-6722634/glodyfrom
docs-nvbug-6722635/glody
Sep 7, 2026
Merged

docs: update Helm chart documentation URLs after nav slug changes#1797
glody merged 1 commit into
docs-nvbug-6722634/glodyfrom
docs-nvbug-6722635/glody

Conversation

@glody

@glody glody commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Summary

helm show readme, install NOTES, and the generated Helm reference still advertise /documentation/self-managed-deployment/... How-to URLs, and the relative examples/opensandbox link becomes a missing Fern docs page.

Stacked on #1796. Merge the earlier docs-link PRs first, then retarget this one to release/0.5.

Related Issue

Changes

  • Rewrite nvidia.com How-to URLs in the Helm README, helm-docs template, values comment, NOTES, and OpenSandbox example README
  • Point the overlay link at the GitHub tree k8s/helm/examples/opensandbox instead of a relative docs path
  • Teach docs/fern/scripts/sync-helm-docs.mjs to keep those rewrites when regenerating docs/helm/index.mdx

Type of Change

  • Code change (feature, bug fix, or refactor)
  • Code change with documentation updates
  • Documentation only
  • Contributor tooling or automation
  • CI, build, or test infrastructure

Quality Gates

  • Tests added or updated for changed behavior
  • Existing tests cover changed behavior — justification:
  • Tests not applicable — justification: Helm README/NOTES/docs-sync URL rewrites; no chart value behavior change
  • Documentation updated for user-visible behavior
  • Documentation not applicable — justification:

Verification

  • Pull request title follows the repository's Conventional Commit format
  • Every commit includes an appropriate Signed-off-by: trailer
  • uv run pre-commit run -a passes, or any blocked checks are identified below
  • Targeted tests pass, or tests are marked not applicable above
  • No secrets, API keys, or credentials are included

Targeted validation:

  • Ran node docs/fern/scripts/sync-helm-docs.mjs with Node 20; generated Helm reference uses Kubernetes Deployment / open-sandbox URLs and the GitHub overlay link.
  • Chart value keys and the k8s/helm/examples/opensandbox/ directory path are unchanged.

helm show readme, NOTES.txt, and the generated Helm reference still
point at /documentation/self-managed-deployment/... and the relative
examples/opensandbox path, which Fern publishes as a missing docs
page. Point How-to URLs at kubernetes-deployment / open-sandbox,
link the overlay to the GitHub tree, and teach sync-helm-docs.mjs
to keep those rewrites on regen.

NVBug 6722635 / NPLAT-56

Signed-off-by: Glody Guo <jinxiang@nvidia.com>
@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

@glody
glody merged commit 690eac7 into docs-nvbug-6722634/glody Sep 7, 2026
5 checks passed
@glody
glody deleted the docs-nvbug-6722635/glody branch September 7, 2026 07:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants