Skip to content

docs: backport published slug and href fixes to release/0.5 - #1852

Open
glody wants to merge 6 commits into
release/0.5from
backport-prs-1794-1797-release-0-5/glody
Open

docs: backport published slug and href fixes to release/0.5#1852
glody wants to merge 6 commits into
release/0.5from
backport-prs-1794-1797-release-0-5/glody

Conversation

@glody

@glody glody commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Backports the published-docs slug and href fixes from #1794, #1795, #1796, and #1797 onto current release/0.5. Those PRs were stacked and merged into #1793, which still targets release/0.5 but is 15 commits behind and conflicts. This replay is based on current origin/release/0.5.

#1794 depends on the kubernetes-deployment retarget from #1793, so that commit is included. A follow-up commit updates v0.5.0 current-release OpenSandbox hrefs that were added after #1794.

Related Issue

Changes

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: documentation-only href, nav slug, redirect, and Helm-docs URL changes
  • 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:

  • make docs-check — passed: 220 MDX files parsed, 75 docs assets resolved, NotebookViewer artifacts validated, no published-to-gated links.
  • make docs-broken-links — 3 remaining errors are pre-existing /documentation/studio/customization links in unchanged Studio pages. The previous current-release /opensandbox 404 is gone after the follow-up commit.
  • Commit-level DCO audit — passed for all 6 commits.
  • git diff --check origin/release/0.5...HEAD — passed.
  • uv run pre-commit run -a was not run locally.

Summary by CodeRabbit

  • Documentation
    • Updated installation, Helm, Kubernetes, OpenSandbox, Models, and Inference links to their current documentation paths.
    • Added redirects for renamed or relocated documentation pages to preserve existing URLs.
    • Added clearer cluster-specific Helm configuration guidance.
    • Added an anchor for linking directly to external provider instructions.
    • Updated generated Helm documentation and installation notes to use current 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>
(cherry picked from commit 5e388eb)
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>
(cherry picked from commit dfd7bfb)
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>
(cherry picked from commit f5bbdc4)
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>
(cherry picked from commit a44480d)
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>
(cherry picked from commit 356778c)
Signed-off-by: Glody Guo <jinxiang@nvidia.com>
The 0.5 notes added OpenSandbox links after #1794. Pinning the nav
slug to open-sandbox leaves those current-release hrefs as 404s.

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

github-actions Bot commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

@coderabbitai

coderabbitai Bot commented Sep 7, 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: c752ac7a-275b-41f4-9f78-0da0019e1eb1

📥 Commits

Reviewing files that changed from the base of the PR and between 86b9ed9 and 2071b8c.

📒 Files selected for processing (32)
  • docs/about/release-notes/current-release.mdx
  • docs/about/release-notes/release-0-3-0.mdx
  • 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/file-storage.mdx
  • docs/set-up/helm/index.mdx
  • docs/set-up/helm/ingress.mdx
  • docs/set-up/helm/install.mdx
  • docs/set-up/helm/network-policy-smoke-test.mdx
  • docs/set-up/helm/opensandbox-kata.mdx
  • docs/set-up/helm/opensandbox.mdx
  • docs/set-up/helm/openshift.mdx
  • docs/set-up/helm/persistent-volumes.mdx
  • docs/set-up/helm/prerequisites.mdx
  • docs/set-up/helm/volcano.mdx
  • docs/set-up/index.mdx
  • docs/set-up/manage-jobs.mdx
  • docs/set-up/milvus.mdx
  • docs/set-up/opentelemetry.mdx
  • docs/support-matrix.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

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


📝 Walkthrough

Walkthrough

The documentation update moves links to current Kubernetes deployment, Models and Inference, OpenSandbox, and Studio plugin routes. It adds redirects, updates navigation slugs, and extends Helm documentation link rewriting.

Changes

Documentation URL Migration

Layer / File(s) Summary
Redirects and route slugs
docs/fern/docs.yml, docs/fern/versions/latest.yml
Added redirects for legacy deployment, OpenSandbox, Models and Inference, and Studio plugin paths. Updated the OpenSandbox and Studio plugin slugs.
Models and Inference links
docs/agents/deploy-agents.mdx, docs/guardrails/..., docs/run-inference/...
Updated Run Inference links and added the external providers anchor.
Kubernetes deployment documentation links
docs/set-up/..., docs/customizer/..., docs/about/release-notes/..., docs/support-matrix.mdx
Replaced legacy self-managed deployment links with Kubernetes deployment links and updated OpenSandbox paths.
Helm references and generated content
docs/fern/scripts/sync-helm-docs.mjs, k8s/helm/...
Expanded URL rewriting for generated Helm documentation, examples, and chart references.

Suggested reviewers: mckornfield

Merge Risk: ⚪ Minimal · up to 2071b

This documentation migration retargets deployment, OpenSandbox, Models and Inference, and Studio plugin links while preserving legacy routes through redirects. The supplied validation and route evidence indicate the change is ready to merge.

🚥 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. (31 skipped: 3… 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 identifies a documentation backport of published slug and href fixes to the release/0.5 branch. This matches the primary changes.
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. (31 skipped: 31 unsupported.)

  • Fix all pre-merge checks with AI
✨ Finishing Touches 💡 1
📝 Generate docstrings 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch backport-prs-1794-1797-release-0-5/glody

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

@github-actions

github-actions Bot commented Sep 7, 2026

Copy link
Copy Markdown
Contributor
Suite Lines Covered Line Rate Branch Rate
Unit Tests 35533/45316 78.4% 62.9%
Integration Tests 21157/43091 49.1% 22.3%

@glody
glody enabled auto-merge September 7, 2026 12:10
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.

1 participant