Skip to content

docs: Post-Merge cleanup of the deploy documentation#1922

Merged
atchernych merged 28 commits intomainfrom
post-merge-doc-cleanup
Jul 21, 2025
Merged

docs: Post-Merge cleanup of the deploy documentation#1922
atchernych merged 28 commits intomainfrom
post-merge-doc-cleanup

Conversation

@atchernych
Copy link
Copy Markdown
Contributor

@atchernych atchernych commented Jul 14, 2025

Overview:

Details:

Where should the reviewer start?

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

Summary by CodeRabbit

  • Documentation
    • Condensed and restructured deployment guides for improved clarity and brevity.
    • Removed detailed step-by-step and example deployment instructions, replacing them with references to installation and example resources.
    • Updated quickstart and example guides to clarify installation options and streamline environment setup.
    • Deleted the manual Helm deployment guide and consolidated example references.
    • Improved formatting and corrected minor typos in example documentation.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 14, 2025

Walkthrough

The changes remove or condense detailed deployment documentation throughout the project. This includes deleting step-by-step guides, example deployments, and references to specific deployment commands or scripts. The remaining documentation now points users to high-level guides and external resources, streamlining instructions and focusing on directing users to core installation and usage materials.

Changes

File(s) Change Summary
deploy/README.md Removed simplified deployment process references, operator guide link, and entire "Example Deployments" section.
docs/examples/llm_deployment.md Clarified headings, fixed typos, removed Kubernetes deployment section, and made minor formatting improvements.
docs/guides/dynamo_deploy/README.md Condensed and restructured deployment guidance; removed detailed procedural content and focused on external docs.
docs/guides/dynamo_deploy/dynamo_cloud.md Simplified and shortened; removed detailed build and deployment instructions, referencing Quickstart Guide.
docs/guides/dynamo_deploy/manual_helm_deployment.md Deleted comprehensive manual Helm deployment guide for Kubernetes.
docs/guides/dynamo_deploy/quickstart.md Clarified install options, restructured example exploration, and improved flow for environment setup.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Documentation

    User->>Documentation: Access deployment instructions
    Documentation-->>User: Directs to high-level guides and external resources
    Note over Documentation: Detailed step-by-step deployment and examples are omitted
Loading

Possibly related PRs

Poem

In burrows deep, the docs were trimmed,
No more long guides or scripts to skim.
Now just a hop to guides anew,
With quickstart paths to follow through.
Deployment tales, concise and neat—
The rabbit’s work is now complete!
🐇✨


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🔭 Outside diff range comments (1)
docs/examples/llm_deployment.md (1)

95-118: Remove duplicated explanatory block

The paragraph from lines 97-107 is repeated verbatim at 108-118, making the Note twice as long and tripping readers.

  Building a vLLM docker image for ARM machines currently involves building vLLM from source, which is known to have performance issues to require extensive system RAM; see [vLLM Issue 8878](https://github.com/vllm-project/vllm/issues/8878).
@@
-When vLLM has pre-built ARM wheels published, this process can be improved.
-
-You can tune the number of parallel build jobs for building VLLM from source
-on ARM based on your available cores and system RAM with `VLLM_MAX_JOBS`.
-
-For example, on an ARM machine with low system resources:
-`./container/build.sh --framework vllm --platform linux/arm64 --build-arg VLLM_MAX_JOBS=2`
-
-For example, on a GB200 which has very high CPU cores and memory resource:
-`./container/build.sh --framework vllm --platform linux/arm64 --build-arg VLLM_MAX_JOBS=64`
-
-When vLLM has pre-built ARM wheels published, this process can be improved.
+When vLLM ships pre-built ARM wheels, this process will simplify.
🧹 Nitpick comments (7)
docs/guides/dynamo_deploy/quickstart.md (3)

4-4: Prefer “can install” over “could install” for clarity

“Could” reads like a hypothetical. “Can install” (or “You can install”) is the common idiom for instructions.

-You could install from [Published Artifacts](#1-installing-from-published-artifacts) or [Source](#2-installing-from-source)
+You can install from [Published Artifacts](#1-installing-from-published-artifacts) or [Source](#2-installing-from-source)

139-151: Streamline the destination-selection snippet

  1. Capitalise “Kubernetes” for consistency.
  2. Consider using a list instead of free-form prose to make the two alternatives visually parallel and easier to scan.
  3. The current layout omits language identifiers on the second code block – stick with ```bash for both.
-Pick your deployment destination.
-
-If local
-
-```bash
-export DYNAMO_CLOUD=http://localhost:8080
-```
-
-If kubernetes
-```bash
-export DYNAMO_CLOUD=https://dynamo-cloud.nvidia.com
-```
+Pick your deployment destination:
+
+- **Local**
+  ```bash
+  export DYNAMO_CLOUD=http://localhost:8080
+  ```
+
+- **Kubernetes**
+  ```bash
+  export DYNAMO_CLOUD=https://dynamo-cloud.nvidia.com
+  ```

161-168: Fix grammar & tighten cross-references

• “Example are stored” → “Examples are stored”.
• Links already imply folder and guide; no need for extra words.

-Example are stored in the [Examples Folder](../../examples/README.md)
-
-Follow the most basic ones in the dedicated guides below:
-
-[Hello World](../../examples/hello_world.md)
-
-[LLM](../../examples/llm_deployment.md)
+Examples live in the [examples directory](../../examples/README.md).
+
+Quick-start guides:
+- [Hello World](../../examples/hello_world.md)
+- [LLM](../../examples/llm_deployment.md)
docs/examples/llm_deployment.md (1)

150-152: Minor casing correction

“Planner” sentence is great; just lower-case the flag to match CLI conventions (--planner.no-operation=false) unless the binary really expects uppercase P.

docs/guides/dynamo_deploy/README.md (2)

18-24: Tighten wording and fix “Prior to”

Replace “Prior to” with “Before” (Wordiness). Also, sentence 20-24 is long; splitting improves readability.

-We expect users to deploy their inference graphs using CRDs or helm charts.
-
-Prior to deploying an inference graph the user should deploy the Dynamo Cloud Platform.
-Dynamo Cloud acts as an orchestration layer between the end user and Kubernetes, handling the complexity of deploying your graphs for you. This is a one-time action, only necessary the first time you deploy a DynamoGraph.
+We expect users to deploy inference graphs via CRDs or Helm charts.
+
+Before deploying a graph, install the Dynamo Cloud Platform.  
+Dynamo Cloud is an orchestration layer that hides Kubernetes complexity and only needs to be installed once for a given cluster.

26-30: Avoid heading numbers inside Markdown heading text

Markdown headings with “# 1.” & “# 2.” render oddly and hurt anchor stability. Prefer plain headings or an ordered list.

-# 1. Please follow [Installing Dynamo Cloud](./dynamo_cloud.md) for steps to install.
-For details about the Dynamo Cloud Platform, see the [Dynamo Operator Guide](dynamo_operator.md)
-
-# 2. Follow [Examples](../../examples/README.md) to see how you can deploy your Inference Graphs.
+## 1  Install Dynamo Cloud  
+See [Installing Dynamo Cloud](./dynamo_cloud.md). For operator details, consult the [Dynamo Operator Guide](dynamo_operator.md).
+
+## 2  Deploy an inference graph  
+Browse the [examples](../../examples/README.md) to get started.
docs/guides/dynamo_deploy/dynamo_cloud.md (1)

56-66: Unclear one-time image instructions

The block mixes “pre-built image” vs “build & push your own” but uses the same variable (DYNAMO_IMAGE) later. Consider explicitly stating which path readers should choose and when to set DYNAMO_IMAGE.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3e0cb07 and 9c2015d.

📒 Files selected for processing (6)
  • deploy/README.md (0 hunks)
  • docs/examples/llm_deployment.md (4 hunks)
  • docs/guides/dynamo_deploy/README.md (1 hunks)
  • docs/guides/dynamo_deploy/dynamo_cloud.md (3 hunks)
  • docs/guides/dynamo_deploy/manual_helm_deployment.md (0 hunks)
  • docs/guides/dynamo_deploy/quickstart.md (3 hunks)
💤 Files with no reviewable changes (2)
  • deploy/README.md
  • docs/guides/dynamo_deploy/manual_helm_deployment.md
🧰 Additional context used
🧠 Learnings (2)
docs/guides/dynamo_deploy/quickstart.md (1)
Learnt from: PeaBrane
PR: ai-dynamo/dynamo#1409
File: examples/router_standalone/worker.py:171-186
Timestamp: 2025-06-08T08:30:45.126Z
Learning: Example code in the `examples/` directory may intentionally use hard-coded values or simplified implementations that wouldn't be appropriate for production code, but are acceptable for demonstration and testing purposes.
docs/guides/dynamo_deploy/dynamo_cloud.md (3)
Learnt from: biswapanda
PR: ai-dynamo/dynamo#1412
File: lib/bindings/python/src/dynamo/runtime/logging.py:100-100
Timestamp: 2025-06-06T21:48:35.214Z
Learning: In the Dynamo codebase, BentoML has been completely removed from all executable code, with only documentation and attribution references remaining. The error_loggers configuration in lib/bindings/python/src/dynamo/runtime/logging.py should not include "bentoml" since those modules no longer exist.
Learnt from: julienmancuso
PR: ai-dynamo/dynamo#1365
File: deploy/cloud/operator/api/v1alpha1/dynamocomponentdeployment_types.go:171-178
Timestamp: 2025-06-04T13:09:53.416Z
Learning: The `DYN_DEPLOYMENT_CONFIG` environment variable (commonconsts.DynamoDeploymentConfigEnvVar) in the Dynamo operator will never be set via ValueFrom (secrets/config maps), only via direct Value assignment. The GetDynamoDeploymentConfig method correctly only checks env.Value for this specific environment variable.
Learnt from: julienmancuso
PR: ai-dynamo/dynamo#1474
File: deploy/cloud/operator/internal/controller/dynamocomponent_controller.go:1302-1306
Timestamp: 2025-06-11T21:18:00.425Z
Learning: In the Dynamo operator, the project’s preferred security posture is to set a Pod-level `PodSecurityContext` with `runAsUser`, `runAsGroup`, and `fsGroup` all set to `1000`, and then selectively override the user at the individual container level (e.g., `RunAsUser: 0` for Kaniko) when root is required.
🪛 LanguageTool
docs/guides/dynamo_deploy/README.md

[style] ~21-~21: ‘Prior to’ might be wordy. Consider a shorter alternative.
Context: ...ence graphs using CRDs or helm charts. Prior to deploying an inference graph the user s...

(EN_WORDINESS_PREMIUM_PRIOR_TO)

🪛 markdownlint-cli2 (0.17.2)
docs/guides/dynamo_deploy/dynamo_cloud.md

69-69: Multiple headings with the same content

(MD024, no-duplicate-heading)

🔇 Additional comments (2)
docs/examples/llm_deployment.md (2)

84-92: Title change looks good

The new heading accurately reflects the step.


119-123: Heading tweak approved

The revised heading clarifies intent without altering meaning.

Comment thread docs/guides/dynamo_deploy/dynamo_cloud.md
Comment thread deploy/README.md Outdated
Comment thread docs/examples/llm_deployment.md Outdated
Comment thread docs/examples/llm_deployment.md
@atchernych atchernych requested a review from whoisj as a code owner July 15, 2025 17:31
@atchernych atchernych requested a review from a team July 15, 2025 17:31
Comment thread .devcontainer/README.md Outdated
Comment thread docs/examples/llm_deployment.md Outdated
Signed-off-by: atchernych <atchernych@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants