Skip to content

chore: address k8s docs wording - #719

Merged
mckornfield merged 1 commit into
mainfrom
helm-docs-pr-review/mck
Jul 16, 2026
Merged

chore: address k8s docs wording#719
mckornfield merged 1 commit into
mainfrom
helm-docs-pr-review/mck

Conversation

@mckornfield

@mckornfield mckornfield commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Clarified CLI guidance to direct users to the Kubernetes deployment guide.
    • Improved Helm installation documentation for configuring EFA networking for multi-node GPU jobs.
    • Updated CLI help text to reference the Kubernetes deployment documentation command.

Signed-off-by: Matt Kornfield <mkornfield@nvidia.com>
@mckornfield
mckornfield requested review from a team as code owners July 15, 2026 21:45
@github-actions github-actions Bot added the chore label Jul 15, 2026
@github-actions

Copy link
Copy Markdown
Contributor

@coderabbitai

coderabbitai Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Updated CLI and documentation wording for Kubernetes deployment guidance and EFA networking references. No runtime behavior or public declarations changed.

Changes

Documentation guidance

Layer / File(s) Summary
Align CLI and documentation guidance
docs/cli/reference.mdx, packages/nemo_platform_ext/src/nemo_platform_ext/cli/app.py, docs/set-up/helm/install.mdx
Kubernetes references now direct readers to the deployment guide, while the EKS example clarifies where to find multinode EFA networking guidance.

Possibly related PRs

Suggested labels: docs

Suggested reviewers: benmccown, tylersbray

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title matches the changeset: it accurately summarizes the Kubernetes docs wording updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch helm-docs-pr-review/mck

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 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/cli/reference.mdx`:
- Line 10: Update the source text that generates the Kubernetes deployment guide
wording, then run make generate-cli-reference-docs to regenerate
docs/cli/reference.mdx. Do not hand-edit the generated reference file.
🪄 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: 4c44ef8b-f85f-4b8f-8358-21c5e5a2d307

📥 Commits

Reviewing files that changed from the base of the PR and between 25ed758 and 2cd58a5.

⛔ Files ignored due to path filters (1)
  • sdk/python/nemo-platform/src/nemo_platform/cli/app.py is excluded by !sdk/**
📒 Files selected for processing (3)
  • docs/cli/reference.mdx
  • docs/set-up/helm/install.mdx
  • packages/nemo_platform_ext/src/nemo_platform_ext/cli/app.py

Comment thread docs/cli/reference.mdx
@github-actions

Copy link
Copy Markdown
Contributor
Suite Lines Covered Line Rate Branch Rate
Unit Tests 25487/32689 78.0% 62.6%
Integration Tests 14702/31338 46.9% 19.2%

@mckornfield
mckornfield requested a review from tylersbray July 15, 2026 22:37

@tylersbray tylersbray left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks dude.

@mckornfield
mckornfield added this pull request to the merge queue Jul 16, 2026
Merged via the queue into main with commit a7e7c21 Jul 16, 2026
59 checks passed
@mckornfield
mckornfield deleted the helm-docs-pr-review/mck branch July 16, 2026 17:21
soluwalana pushed a commit that referenced this pull request Jul 17, 2026
Signed-off-by: Matt Kornfield <mkornfield@nvidia.com>
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.

2 participants