docs: backport published slug and href fixes to release/0.5 - #1852
Conversation
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>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (32)
Included review availability: Your plan provides up to 12 included reviews per hour; 10 remain after this review. 📝 WalkthroughWalkthroughThe 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. ChangesDocumentation URL Migration
Suggested reviewers: Merge Risk: ⚪ Minimal · up to 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)
✅ Passed checks (4 passed)
Full details: Docstring CoverageExplanation 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.)
✨ Finishing Touches 💡 1📝 Generate docstrings 💡
🧪 Generate unit tests (beta)
Comment |
|
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 targetsrelease/0.5but is 15 commits behind and conflicts. This replay is based on currentorigin/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
self-managed-deploymenthrefs tokubernetes-deployment.open-sandboxand redirect the old leaf./tutorials/from Models and Inference links.plugins.open-sandbox.Type of Change
Quality Gates
Verification
Signed-off-by:traileruv run pre-commit run -apasses, or any blocked checks are identified belowTargeted 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/customizationlinks in unchanged Studio pages. The previous current-release/opensandbox404 is gone after the follow-up commit.git diff --check origin/release/0.5...HEAD— passed.uv run pre-commit run -awas not run locally.Summary by CodeRabbit