docs: retarget self-managed-deployment links to kubernetes-deployment - #1793
docs: retarget self-managed-deployment links to kubernetes-deployment#1793glody wants to merge 9 commits into
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>
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>
|
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 (17)
🚧 Files skipped from review as they are similar to previous changes (4)
Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review. 📝 WalkthroughWalkthroughDocumentation links were migrated from self-managed deployment paths to Kubernetes deployment paths. Redirects preserve legacy URLs. Helm synchronization and relocated documentation links were updated. ChangesKubernetes documentation path migration
Suggested reviewers: Merge Risk: ⚪ Minimal · up to 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)
✅ 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. (16 skipped: 16 unsupported.)
✨ Finishing Touches 💡 2📝 Generate docstrings 💡
⚔️ Resolve merge conflicts 💡
🧪 Generate unit tests (beta)
Comment |
|
| @@ -181,7 +181,7 @@ See [Setup](/documentation/get-started) for prerequisites and provider | |||
| configuration. | |||
|
|
|||
| For self-managed Kubernetes, start with | |||
There was a problem hiding this comment.
@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. | |||
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
|
Closing in favor of #1852, which cherry-picks this stack onto current |
Summary
Published 0.5 docs still hardcode
/documentation/self-managed-deployment/after the nav slug becamekubernetes-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.5in this order:Related Issue
Changes
/documentation/self-managed-deployment/with/documentation/kubernetes-deployment/in the affected setup/Helm/customizer MDX pages/documentation/kubernetes-deployment/setup/helm(the old/helmsection URL has no page)/documentation/self-managed-deployment/:path*and the exact/helmsection URLType of Change
Quality Gates
Verification
Signed-off-by:traileruv run pre-commit run -apasses, or any blocked checks are identified belowTargeted validation:
docs_broken_links.csv) against current Fern nav slugs onrelease/0.5.opensandboxleaf hrefs are intentionally unchanged here; they are NVBug 6722631.Summary by CodeRabbit