Skip to content

docs: retarget self-managed-deployment links to kubernetes-deployment - #1793

Closed
glody wants to merge 9 commits into
release/0.5from
docs-nvbug-6722623/glody
Closed

docs: retarget self-managed-deployment links to kubernetes-deployment#1793
glody wants to merge 9 commits into
release/0.5from
docs-nvbug-6722623/glody

Conversation

@glody

@glody glody commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Summary

Published 0.5 docs still hardcode /documentation/self-managed-deployment/ after the nav slug became kubernetes-deployment, so those pages 404 on docs.nvidia.com. This retargets the MDX hrefs and adds Fern redirects for the old slug.

This is the first of five stacked docs-link PRs for OSS 0.5.0. Merge into release/0.5 in this order:

  1. This PR — NVBug 6722623
  2. docs: pin OpenSandbox how-to slug to open-sandbox #1794 — NVBug 6722631
  3. docs: drop stale /tutorials/ from Models and Inference links #1795 — NVBug 6722632
  4. docs: pin Studio Plugin UIs nav slug to plugins #1796 — NVBug 6722634
  5. docs: update Helm chart documentation URLs after nav slug changes #1797 — NVBug 6722635

Related Issue

Changes

  • Replace /documentation/self-managed-deployment/ with /documentation/kubernetes-deployment/ in the affected setup/Helm/customizer MDX pages
  • Point the support-matrix Helm install link at /documentation/kubernetes-deployment/setup/helm (the old /helm section URL has no page)
  • Redirect /documentation/self-managed-deployment/:path* and the exact /helm section URL

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: published docs href and Fern redirect changes only
  • 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:

Summary by CodeRabbit

  • Documentation
    • Updated Kubernetes and Helm setup links to use current deployment paths.
    • Added redirects from legacy and relocated documentation URLs, including Models and Inference, Studio Plugin, and OpenSandbox pages.
    • Expanded Helm setup guidance and corrected OpenSandbox and repository links.
    • Updated references across installation, storage, networking, OpenShift, observability, Milvus, Volcano, and OpenSandbox guides.
    • Added a direct anchor for external provider setup and corrected related model deployment links.

Published MDX still hardcodes /documentation/self-managed-deployment/
after the nav slug became kubernetes-deployment, so those pages 404.
Rewrite the hrefs and add Fern redirects for the old slug, including
the support-matrix Helm install link that pointed at a section URL
with no page.

NVBug 6722623 / NPLAT-51

Signed-off-by: Glody Guo <jinxiang@nvidia.com>
Run Inference and Deploy Models are published directly under
/documentation/models-and-inference/, but remaining hrefs still
include /tutorials/ and 404. Update those links, pin the Deploy
Models add-external-providers fragment, and redirect the old URLs.

NVBug 6722632 / NPLAT-54

Signed-off-by: Glody Guo <jinxiang@nvidia.com>
Fern kebab-cases the page title OpenSandbox to open-sandbox, but
internal hrefs still used /setup/helm/opensandbox and 404. Pin the
nav slug and retarget those leaf links. opensandbox-kata and the
GitHub example overlay path are unchanged.

NVBug 6722631 / NPLAT-53

Signed-off-by: Glody Guo <jinxiang@nvidia.com>
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>
Studio already links Iron Swarm to /documentation/studio/plugins,
but Fern kebab-cases "Plugin UIs in NeMo Studio" to plugin-u-is,
so that page 404s. Pin slug: plugins and redirect the generated
slug.

NVBug 6722634 / NPLAT-55

Signed-off-by: Glody Guo <jinxiang@nvidia.com>
@glody
glody requested review from a team as code owners September 4, 2026 09:33
@github-actions github-actions Bot added the docs label Sep 4, 2026
@coderabbitai

coderabbitai Bot commented Sep 4, 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: CHILL

Plan: Enterprise

Run ID: 1f8c7d03-17f2-431d-bcc9-f22f7e6f57a7

📥 Commits

Reviewing files that changed from the base of the PR and between 5e388eb and ac93e6d.

📒 Files selected for processing (17)
  • docs/agents/deploy-agents.mdx
  • docs/customizer/grpo-training.mdx
  • docs/customizer/tutorials/grpo-environment-packages.mdx
  • docs/fern/docs.yml
  • docs/fern/scripts/sync-helm-docs.mjs
  • docs/fern/versions/latest.yml
  • docs/guardrails/concepts/configurations/default-configs.mdx
  • docs/run-inference/tutorials/deploy-models.mdx
  • docs/run-inference/tutorials/index.mdx
  • docs/set-up/helm/index.mdx
  • docs/set-up/helm/install.mdx
  • docs/set-up/helm/opensandbox-kata.mdx
  • k8s/helm/README.md
  • k8s/helm/examples/opensandbox/README.md
  • k8s/helm/helm-docs-template/nemo-helm-readme.md.gotmpl
  • k8s/helm/templates/NOTES.txt
  • k8s/helm/values.yaml
🚧 Files skipped from review as they are similar to previous changes (4)
  • docs/set-up/helm/opensandbox-kata.mdx
  • docs/customizer/tutorials/grpo-environment-packages.mdx
  • docs/customizer/grpo-training.mdx
  • docs/set-up/helm/install.mdx

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


📝 Walkthrough

Walkthrough

Documentation links were migrated from self-managed deployment paths to Kubernetes deployment paths. Redirects preserve legacy URLs. Helm synchronization and relocated documentation links were updated.

Changes

Kubernetes documentation path migration

Layer / File(s) Summary
Legacy URL redirects
docs/fern/docs.yml
Added redirects for legacy deployment, Models and Inference, OpenSandbox, and Studio plugin URLs.
Documentation URL synchronization
docs/fern/scripts/sync-helm-docs.mjs, docs/fern/versions/latest.yml
Updated Helm link rewriting and added navigation slugs for Studio plugins and OpenSandbox.
Helm documentation links
docs/set-up/helm/*
Updated Helm references to Kubernetes deployment paths and corrected OpenSandbox destinations.
Related documentation references
docs/about/release-notes/*, docs/customizer/*, docs/set-up/*, docs/support-matrix.mdx, docs/agents/*, docs/guardrails/*, docs/run-inference/*, k8s/helm/*
Updated related documentation and Helm chart references to current destinations.

Suggested reviewers: mckornfield, gabwow

Merge Risk: ⚪ Minimal · up to ac93e

This updates Kubernetes deployment documentation links, legacy redirects, and Helm-generated documentation references without changing deployment behavior. The supplied context shows destinations and anchors are aligned, so no current merge-blocking risk remains.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 3 functions across 1 files. (16 skipped: 1… Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main change: retargeting documentation links from the old self-managed deployment path to the Kubernetes deployment path.
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.
Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 3 functions across 1 files. (16 skipped: 16 unsupported.)

  • Fix all pre-merge checks with AI
✨ Finishing Touches 💡 2
📝 Generate docstrings 💡
  • Create stacked PR
  • Commit on current branch
⚔️ Resolve merge conflicts 💡
  • Resolve merge conflict in branch docs-nvbug-6722623/glody
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-nvbug-6722623/glody

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

@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor
Suite Lines Covered Line Rate Branch Rate
Unit Tests 35518/45299 78.4% 62.9%
Integration Tests 21145/43074 49.1% 22.3%

@@ -181,7 +181,7 @@ See [Setup](/documentation/get-started) for prerequisites and provider
configuration.

For self-managed Kubernetes, start with

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

@glody should this change to remove self managed or leave it as is?

@@ -9,95 +9,95 @@ description: ""

NeMo Platform is bundled in an all-in-one Helm chart for self-managed Kubernetes deployments. Use these guides to deploy the platform on local clusters such as minikube and kind, managed clusters such as EKS, AKS, GKE, and OKE, or on-prem Kubernetes.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

same question here

docs: update Helm chart documentation URLs after nav slug changes
docs: pin Studio Plugin UIs nav slug to plugins
docs: drop stale /tutorials/ from Models and Inference links
docs: pin OpenSandbox how-to slug to open-sandbox
@glody

glody commented Sep 7, 2026

Copy link
Copy Markdown
Contributor Author

#1794#1797 were stacked into this branch, but this PR is now behind current release/0.5 and conflicts.

I cherry-picked the stack onto current origin/release/0.5 as #1852. Prefer merging that PR for the 0.5 docs slug/href fixes; this one can be closed after 1852 lands if it is no longer needed.

@glody

glody commented Sep 7, 2026

Copy link
Copy Markdown
Contributor Author

Closing in favor of #1852, which cherry-picks this stack onto current release/0.5.

@glody glody closed this Sep 7, 2026
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.

3 participants