fix(docs): fix broken links from GitLab-to-GitHub migration#336
Open
pdmack wants to merge 4 commits into
Open
Conversation
Replace three categories of broken links identified in NVBug 6482070: 1. AGENTS.md links in docs/dev/architecture.md used relative paths (../../src/.../AGENTS.md) that Fern resolved as docs.nvidia.com/src/... URLs (404). Changed to absolute github.com/NVIDIA/nvcf/blob/main URLs. 2. Sample file links in helmfile, standalone, local-dev, and troubleshooting docs used relative paths (samples/configs/..., samples/scripts/...) that Fern cannot serve. Changed to raw.githubusercontent.com URLs pointing to the files in the repo. 3. Links to the archived NVIDIA/nv-cloud-function-helpers repo updated to point to the equivalent content in NVIDIA/nvcf/examples/, with path renames from underscore to hyphen convention. Fixes 36 of the 58 broken URLs in NVBug 6482070. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.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 (7)
🚧 Files skipped from review as they are similar to previous changes (3)
📝 WalkthroughWalkthroughDocumentation links were migrated from relative paths and the archived ChangesDocumentation link migration
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
🌿 Preview your docs: https://nvidia-preview-fix-docs-migration-broken-links.docs.buildwithfern.com/nvcf |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 9
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/dev/grpc-load-testing.md`:
- Line 40: Replace the stale nv-cloud-function-helpers link labels with
NVIDIA/nvcf or the current example name while preserving the migrated URLs:
update the deployment link in docs/dev/grpc-load-testing.md:40-40,
docs/dev/http-load-testing.md:32-32, docs/dev/http-soak-testing.md:35-35,
docs/v0.5/grpc-load-testing.md:40-40, docs/v0.5/http-soak-testing.md:35-35,
docs/v0.6.0/grpc-load-testing.md:40-40, docs/v0.6.0/http-load-testing.md:32-32,
and docs/v0.6.0/http-soak-testing.md:35-35; update the script-maintenance link
label in docs/dev/http-soak-testing.md:165-166,
docs/v0.5/http-soak-testing.md:166-167, and
docs/v0.6.0/http-soak-testing.md:162-163.
- Line 45: Replace the non-cloneable repository URLs with the repository root
and update the subsequent working-directory paths to use the corresponding
nvcf/examples locations: docs/dev/grpc-load-testing.md lines 45 and 118,
docs/dev/http-load-testing.md lines 37 and 103, docs/dev/http-soak-testing.md
line 40, docs/v0.5/grpc-load-testing.md lines 45 and 114,
docs/v0.5/http-soak-testing.md line 40, docs/v0.6.0/grpc-load-testing.md lines
45 and 118, docs/v0.6.0/http-load-testing.md lines 37 and 103, and
docs/v0.6.0/http-soak-testing.md line 40.
In `@docs/ngc-managed/cluster-management/monitoring.md`:
- Line 24: Replace the generic “here” link text with descriptive text
identifying the OpenTelemetry Collector cluster monitoring sample in
docs/ngc-managed/cluster-management/monitoring.md:24,
docs/user/cluster-management/monitoring.md:24, and
docs/v0.6.0/cluster-management/monitoring.md:24, preserving the existing
destination URL.
In `@docs/user/cli.md`:
- Line 347: Rename the visible nv-cloud-function-helpers link label to “NVCF
examples” or similar while preserving the existing NVIDIA/nvcf URL and
surrounding documentation. Apply this change at docs/user/cli.md:347-347,
docs/v0.6.0/cli.md:340-340, and docs/v0.6.0/observability.md:298-298.
In `@docs/user/function-creation.md`:
- Line 51: Rename the migrated link labels to match the NVCF examples
destination: update “NVCF Container Helper Functions” to “NVCF examples” in
docs/user/function-creation.md and docs/v0.5/function-creation.md, and replace
“nv-cloud-function-helpers” with “NVCF examples” in docs/user/observability.md,
docs/v0.5/cli.md, and docs/v0.5/observability.md.
In `@docs/v0.5/cluster-management/monitoring.md`:
- Line 24: Update the OpenTelemetry Collector link in the cluster monitoring
documentation to use descriptive link text such as “cluster monitoring example”
instead of “here,” while preserving the existing destination URL.
In `@docs/v0.5/helmfile-installation.md`:
- Line 730: Move the Kubernetes context-selection instructions from Step 5 to
before Step 4, before the create-nvcr-pull-secrets.sh step and its kubectl
commands. Keep Step 5 as a confirmation that the intended context is selected,
without removing the safety check.
In `@docs/v0.5/local-development.md`:
- Line 27: Update the repository reference in the local development instructions
so its visible label matches NVIDIA/nvcf. Add the checkout step to change into
examples/function-samples before running ./setup.sh, or link directly to the
setup script while preserving the intended setup flow.
In `@docs/v0.6.0/function-creation.md`:
- Line 51: Update the Markdown link text in the function-creation documentation
to match the general examples destination, using “NVCF examples”; alternatively,
change the URL to the specific helper implementation only if that destination
exists.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 49c87c8e-9eb4-4a66-98b4-b3eb0b56c809
📒 Files selected for processing (38)
docs/dev/architecture.mddocs/dev/grpc-load-testing.mddocs/dev/http-load-testing.mddocs/dev/http-soak-testing.mddocs/ngc-managed/cluster-management/monitoring.mddocs/user/cli.mddocs/user/cluster-management/monitoring.mddocs/user/container-functions.mddocs/user/function-creation.mddocs/user/helm-functions.mddocs/user/helmfile-installation.mddocs/user/observability.mddocs/user/troubleshooting.mddocs/v0.5/cli.mddocs/v0.5/cluster-management/monitoring.mddocs/v0.5/container-functions.mddocs/v0.5/function-creation.mddocs/v0.5/grpc-load-testing.mddocs/v0.5/helm-functions.mddocs/v0.5/helmfile-installation.mddocs/v0.5/http-soak-testing.mddocs/v0.5/local-development.mddocs/v0.5/observability.mddocs/v0.5/standalone-core-services.mddocs/v0.5/standalone-gateway.mddocs/v0.5/standalone-infrastructure.mddocs/v0.5/troubleshooting.mddocs/v0.6.0/cli.mddocs/v0.6.0/cluster-management/monitoring.mddocs/v0.6.0/container-functions.mddocs/v0.6.0/function-creation.mddocs/v0.6.0/grpc-load-testing.mddocs/v0.6.0/helm-functions.mddocs/v0.6.0/helmfile-installation.mddocs/v0.6.0/http-load-testing.mddocs/v0.6.0/http-soak-testing.mddocs/v0.6.0/observability.mddocs/v0.6.0/troubleshooting.md
sbaum1994
approved these changes
Jul 21, 2026
- Fix broken git clone URLs in load-testing docs: the first commit incorrectly produced /tree/main/examples.git URLs which cannot be cloned. Changed to git clone https://github.com/NVIDIA/nvcf.git with corrected cd paths (nvcf/examples/... with hyphenated names). - Update stale link text: labels still named nv-cloud-function-helpers after URLs were migrated to nvcf. Renamed to NVCF examples. - Replace bare 'here' link text in monitoring docs with descriptive 'cluster monitoring example'. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Contributor
Author
|
Addressed in the follow-up commit ac4bf2f:
The helmfile-installation.md Step 4/5 context ordering note is pre-existing and tracked separately. |
Contributor
Validation gap: |
- docs/v0.5/local-development.md: the k3d setup tip incorrectly pointed to examples/function-samples which has no setup.sh. Point to tools/ncp-local-cluster with make as the correct workflow. - container-functions.md (all versions): fix two remaining nv-cloud-function-helpers links missed in the first pass -- bare /examples link and helper_library path -- and update to nvcf/examples and src/libraries/python/nv-cloud-function-helpers respectively. - function-creation.md (all versions): the helper library reference was updated to the generic examples directory where the library does not exist. Point to src/libraries/python/nv-cloud-function-helpers instead. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Contributor
Author
|
Thanks for the careful review. Addressed in 597c646:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
TL;DR
Fix 36 of the 58 broken URLs identified in NVBug 6482070, covering three categories of migration artifacts in the docs source.
Additional Details
Production scan of docs.nvidia.com found 58 unique broken URLs (75 rows counting duplicates across pages). This PR addresses the three categories where the fix lives in the docs source:
Category 1 -- AGENTS.md relative paths (10 URLs, 1 file)
docs/dev/architecture.mdlinks to per-component AGENTS.md files as relative filesystem paths (../../src/.../AGENTS.md). Fern resolves these asdocs.nvidia.com/src/...which returns 404. Changed to absolutegithub.com/NVIDIA/nvcf/blob/main/...URLs.Category 2 -- Sample file download links (17 URLs, 10 files)
Helmfile installation, standalone, local-dev, and troubleshooting docs link to sample configs and scripts as relative paths (
samples/configs/...,samples/scripts/...). Fern cannot serve non-markdown files, so these become deaddocs.nvidia.com/.../samples/...URLs. Changed toraw.githubusercontent.comURLs pointing to the files in the repo.Category 3 -- Archived nv-cloud-function-helpers repo (9 URLs, 28 files)
NVIDIA/nv-cloud-function-helpersis archived. Content migrated toNVIDIA/nvcf/examples/with path renames (underscores to hyphens, e.g.function_samples/tofunction-samples/). Updated all links with corrected paths.Remaining 22 broken URLs (Omniverse dead links and old slugs already fixed at source) are not addressed here.
For the Reviewer
38 files changed, all in
docs/. Changes are mechanical link replacements -- no content changes. Verified withlychee --offline(0 errors after changes).For QA
lychee --offline --no-progress 'docs/**/*.md'-- 0 errors.Issues
Fixes #335
Checklist
Summary by CodeRabbit