Skip to content

docs(operator): refresh stale image tags in API doc-comment examples - #13270

Merged
dagil-nvidia merged 4 commits into
mainfrom
dagil/fix-operator-doc-example-tags
Aug 16, 2026
Merged

dagil-nvidia merged 4 commits into
mainfrom
dagil/fix-operator-doc-example-tags

Conversation

@dagil-nvidia

@dagil-nvidia dagil-nvidia commented Aug 14, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

The DGDR Go doc-comment Example: strings still cited dynamo-planner:1.2.1 / vllm-runtime:1.2.1, and two hand-authored CRD reference pages cited vllm-runtime:0.6.0. These strings propagate into the generated CRD YAML, the Kubernetes API reference pages, and the Python mirror, so all surfaces are updated together to 1.4.0:

  • deploy/operator/api/v1beta1/dynamographdeploymentrequest_types.go and v1alpha1 (both API versions checked)
  • deploy/operator/config/crd/bases/nvidia.com_dynamographdeploymentrequests.yaml
  • docs/fern/pages/reference/kubernetes-api/{dynamo-graph-deployment-request,full-api-reference,dynamo-component-deployment,dynamo-graph-deployment}.mdx and additional-resources/api-reference-k8s.md
  • components/src/dynamo/profiler/utils/dgdr_v1beta1_types.py

Fixing at the Go source keeps future doc regens from reintroducing the stale tags (a prior sweep found 22 stale planner tags hiding behind this pattern).

Validation

  • grep -rn 'planner:1.2.1|vllm-runtime:1.2.1|vllm-runtime:0.6.0' across deploy/operator/, the K8s API docs pages, and the profiler mirror → no matches.
  • pre-commit run on all changed files → clean.

🤖 Generated with Claude Code


Open in Devin Review

Summary by CodeRabbit

  • Documentation
    • Updated Kubernetes API examples to use Dynamo image version 1.4.0.
    • Updated worker, profiler, planner, and profiling job image examples.
    • Updated minimal deployment examples to use vllm-runtime:1.4.0.
    • Synchronized image version references across API schemas and reference documentation.

The Example strings in the DGDR Go doc comments still cited
dynamo-planner:1.2.1 / vllm-runtime:1.2.1, and two hand-authored CRD
reference pages cited vllm-runtime:0.6.0. These strings propagate into
the generated CRD YAML, both Kubernetes API reference pages, and the
Python mirror in dgdr_v1beta1_types.py, so all seven surfaces are
updated together to 1.4.0 (v1alpha1 and v1beta1 both checked).

Signed-off-by: Dan Gil <dagil@nvidia.com>
@dagil-nvidia
dagil-nvidia requested review from a team as code owners August 14, 2026 18:58
@github-actions github-actions Bot added docs documentation Improvements or additions to documentation deployment::k8s Relates to dynamo deployment in kubernetes planner labels Aug 14, 2026
@dagil-nvidia

Copy link
Copy Markdown
Collaborator Author

/ok to test 1cec9ef

@devin-ai-integration devin-ai-integration 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.

Devin Review found 1 potential issue.

Open in Devin Review

@github-actions

github-actions Bot commented Aug 14, 2026 •

Copy link
Copy Markdown
Contributor

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 1cec9ef546

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@coderabbitai

coderabbitai Bot commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 80bd764b-c018-42c1-90cd-2d21d99a565b

📥 Commits

Reviewing files that changed from the base of the PR and between b40a3e3 and 1cec9ef.

📒 Files selected for processing (9)
  • components/src/dynamo/profiler/utils/dgdr_v1beta1_types.py
  • deploy/operator/api/v1alpha1/dynamographdeploymentrequest_types.go
  • deploy/operator/api/v1beta1/dynamographdeploymentrequest_types.go
  • deploy/operator/config/crd/bases/nvidia.com_dynamographdeploymentrequests.yaml
  • docs/fern/pages/reference/kubernetes-api/additional-resources/api-reference-k8s.md
  • docs/fern/pages/reference/kubernetes-api/dynamo-component-deployment.mdx
  • docs/fern/pages/reference/kubernetes-api/dynamo-graph-deployment-request.mdx
  • docs/fern/pages/reference/kubernetes-api/dynamo-graph-deployment.mdx
  • docs/fern/pages/reference/kubernetes-api/full-api-reference.mdx

Walkthrough

The pull request updates API comments, CRD examples, and Kubernetes reference documentation to use Dynamo image version 1.4.0. It also updates minimal deployment examples from vllm-runtime:0.6.0 to vllm-runtime:1.4.0.

Changes

Dynamo image version documentation

Layer / File(s) Summary
API example tags
components/src/dynamo/profiler/utils/dgdr_v1beta1_types.py, deploy/operator/api/...
API documentation examples now use Dynamo image version 1.4.0.
CRD schema examples
deploy/operator/config/crd/bases/...
CRD examples now use version 1.4.0 for worker and profiling images.
Kubernetes reference examples
docs/fern/pages/reference/kubernetes-api/...
Reference examples now use 1.4.0 for runtime, worker, profiler, and planner images.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to 1cec9

This PR refreshes stale image tags in API examples without changing runtime behavior. The source and generated documentation are updated consistently, so no actionable merge-blocking risk remains after normal checks and review.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the changes and validation, but it omits the required Related Issues section and the reviewer starting point. Add the required Related Issues section and identify the specific files or section where the reviewer should start.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: refreshing stale image tags in API documentation examples.
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.

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 golangci-lint (2.12.2)

Error: can't load config: unsupported version of the configuration: "" See https://golangci-lint.run/docs/product/migration-guide for migration instructions
The command is terminated due to an error: can't load config: unsupported version of the configuration: "" See https://golangci-lint.run/docs/product/migration-guide for migration instructions


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

The doc-comment examples cite dynamo-planner:1.4.0; the shipped sample
still pinned 1.3.0. v1.4.0 is published, so both now reference the
released tag.

Signed-off-by: Dan Gil <dagil@nvidia.com>
@dagil-nvidia

Copy link
Copy Markdown
Collaborator Author

/ok to test 50cd3ec

… path

Same fix as #13314 on the release branch and #13269 for the live site:
xgrammar moved its docs under /docs/latest/ and the old URL returns 404,
which fails lychee on any main-based docs PR until #13269 merges.

Signed-off-by: Dan Gil <dagil@nvidia.com>
@datadog-official

This comment has been minimized.

@dagil-nvidia

Copy link
Copy Markdown
Collaborator Author

/ok to test 5d5daca

Same harness fix as on the notes PR: the tag publish put v1.4.0.yml on
docs-website with the notes-page pointer main's nav does not carry yet,
so the replayed propagation produces pages-dev diffs the pre-rework
assertion wrongly counts. Scope the assertion to versions with no
pages-dev refs and scrub the sim page from every synced version file.

Signed-off-by: Dan Gil <dagil@nvidia.com>
@dagil-nvidia

Copy link
Copy Markdown
Collaborator Author

/ok to test e3ac943

@PeaBrane PeaBrane 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.

✅

@dagil-nvidia
dagil-nvidia merged commit 8097ac7 into main Aug 16, 2026
119 checks passed
@dagil-nvidia
dagil-nvidia deleted the dagil/fix-operator-doc-example-tags branch August 16, 2026 19:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

deployment::k8s Relates to dynamo deployment in kubernetes docs documentation Improvements or additions to documentation planner size/M

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants