Skip to content

Conversation

sozercan
Copy link

@sozercan sozercan commented Oct 14, 2025

Overview:

fixes broken links in https://docs.nvidia.com/dynamo/latest/kubernetes/README.html

Details:

Where should the reviewer start?

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

  • closes GitHub issue: #xxx

Summary by CodeRabbit

  • Documentation
    • Updated Kubernetes documentation to use relative links aligned with the new structure.
    • Corrected references in installation and backend deployment guides to point to the appropriate sections.
    • Refreshed navigation for Examples, Multinode Deployment, Logging, Monitoring, and Model Caching to ensure consistency.
    • Standardized link text and formatting for improved readability.
    • Fixed broken or outdated references to API and operator guides.

Signed-off-by: Sertac Ozercan <[email protected]>
Copy link

copy-pr-bot bot commented Oct 14, 2025

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@github-actions github-actions bot added the docs label Oct 14, 2025
Copy link

👋 Hi sozercan! Thank you for contributing to ai-dynamo/dynamo.

Just a reminder: The NVIDIA Test Github Validation CI runs an essential subset of the testing framework to quickly catch errors.Your PR reviewers may elect to test the changes comprehensively before approving your changes.

🚀

Copy link
Contributor

coderabbitai bot commented Oct 14, 2025

Walkthrough

Updated docs/kubernetes/README.md to convert absolute “/”-prefixed links to relative paths, align references to specific Markdown files in the repo, adjust navigation sections to the new structure, and normalize link text formatting.

Changes

Cohort / File(s) Summary
Docs link updates
docs/kubernetes/README.md
Converted absolute links to relative paths; updated references to api_reference.md, dynamo_operator.md, create_deployment.md, installation_guide.md, and backend deploy README paths; adjusted navigation links (Examples, Multinode, Logging, Grove, Monitoring, Model Caching); minor link text normalization.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I hopped through docs with nimble feet,
Turning roots to paths so neat.
Links now find their burrows true,
Relative trails in fresher hue.
Thump-thump! The README’s lanes align—
A happy hare, commit so fine. 🥕

Pre-merge checks

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description Check ⚠️ Warning Although the required section headings are present, the Details and Where should the reviewer start sections contain only placeholder comments and no substantive information about what was changed or which files to inspect. The Overview partially describes the scope and the Related Issues lists a placeholder issue number, but the description is largely incomplete and does not guide reviewers. Please populate the Details section with a concise summary of the actual link updates made and specify in the Where should the reviewer start section which files or sections of the README require focused review. Ensure the Related Issues entry references the actual issue number.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The title succinctly and accurately summarizes the primary change of this pull request, which is fixing broken links in the Kubernetes README. It references the documentation change and target file without extraneous detail. It clearly indicates the context and nature of the change, helping reviewers understand the PR purpose at a glance.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f26d8da and eb5c80e.

📒 Files selected for processing (1)
  • docs/kubernetes/README.md (4 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/kubernetes/README.md

[grammar] ~49-~49: There might be a mistake here.
Context: ... | Backend | Available Configurations | |---------|--------------------------| |...

(QB_NEW_EN)


[grammar] ~50-~50: There might be a mistake here.
Context: ...| |---------|--------------------------| | **[vLLM](../../components/backends/vll...

(QB_NEW_EN)


[grammar] ~51-~51: There might be a mistake here.
Context: ...ed + Planner, Disaggregated Multi-node | | **[SGLang](../../components/backends/s...

(QB_NEW_EN)


[grammar] ~52-~52: There might be a mistake here.
Context: ...ed + Planner, Disaggregated Multi-node | | **[TensorRT-LLM](../../components/back...

(QB_NEW_EN)


[grammar] ~88-~88: There might be a mistake here.
Context: ...ls. ## 📖 API Reference & Documentation For detailed technical specifications of...

(QB_NEW_EN)


[grammar] ~93-~93: There might be a mistake here.
Context: ...mo operator configuration and management - **Create Deployment...

(QB_NEW_EN)


[grammar] ~177-~177: There might be a mistake here.
Context: ...README.md)** - Complete working examples - **[Create Custom Deployments](create_deploy...

(QB_NEW_EN)


[grammar] ~178-~178: There might be a mistake here.
Context: ...e_deployment.md)** - Build your own CRDs - **[Operator Documentation](dynamo_operator....

(QB_NEW_EN)


[grammar] ~179-~179: There might be a mistake here.
Context: ..._operator.md)** - How the platform works - **[Helm Charts](../../deploy/helm/README.md...

(QB_NEW_EN)


[grammar] ~180-~180: There might be a mistake here.
Context: ...y/helm/README.md)** - For advanced users - **[GitOps Deployment with FluxCD](fluxcd.md...

(QB_NEW_EN)


[grammar] ~181-~181: There might be a mistake here.
Context: ...luxCD](fluxcd.md)** - For advanced users - Logging - For logging set...

(QB_NEW_EN)


[grammar] ~182-~182: There might be a mistake here.
Context: ...gging](logging.md)** - For logging setup - **[Multinode Deployment](multinode-deployme...

(QB_NEW_EN)


[grammar] ~183-~183: There might be a mistake here.
Context: ...loyment.md)** - For multinode deployment - Grove - For grove details a...

(QB_NEW_EN)


[grammar] ~184-~184: There might be a mistake here.
Context: ...or grove details and custom installation - Monitoring - For monitori...

(QB_NEW_EN)


[grammar] ~185-~185: There might be a mistake here.
Context: ...ng](metrics.md)** - For monitoring setup - **[Model Caching with Fluid](model_caching_...

(QB_NEW_EN)


[grammar] ~186-~186: There might be a mistake here.
Context: ...uid.md)** - For model caching with Fluid

(QB_NEW_EN)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Build and Test - dynamo

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@github-actions github-actions bot added the external-contribution Pull request is from an external contributor label Oct 14, 2025
Copy link
Contributor

@athreesh athreesh left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for the updates Sertac!

@athreesh athreesh enabled auto-merge (squash) October 15, 2025 16:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs external-contribution Pull request is from an external contributor size/M

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants