RHAI-ENG-306-modify-docs-on-deploying-llamastackdistribution-instanc…

[chtyler]

…e - modified distribution image name in example yaml and modified prereq

Description

The LlamaStackDistribution example has been modified to change the location of the distribution image. In addition, content has been removed that is now invalid. Finally, a prerequisite item has been modified so that it more realistically represents the task that should have been carried out beforehand.

How Has This Been Tested?

Merge criteria:

• The commits are squashed in a cohesive manner and have meaningful messages.
• Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
• The developer has manually tested the changes and verified that the changes work

Summary by CodeRabbit

• Documentation
  • Updated prerequisite wording to indicate activation rather than installation of the Llama Stack Operator.
  • Revised and simplified image reference details for Llama Stack, updating example YAML to use the new image name.
  • Removed outdated notes about image registry locations and clarified documentation content.

[coderabbitai]

Walkthrough

The documentation was updated to revise the prerequisite wording for the Llama Stack Operator and to update the LlamaStackDistribution image reference and registry information. Details about the image's hosting and related notes were removed, and the example YAML was modified to use a new image reference.

Changes

Cohort / File(s)	Change Summary
Llama Model Deployment Documentation modules/deploying-a-llama-model-with-kserve.adoc	Changed prerequisite wording from "installed" to "activated" for the Llama Stack Operator.
LlamaStackDistribution Documentation modules/deploying-a-llamastackdistribution-instance.adoc	Removed detailed image registry explanation and note; updated example YAML image reference from quay.io/opendatahub/llama-stack:odh to rh-dev; removed a blank line before the procedure.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• Rag assembly finalization #859: Adds the same deployment modules to an assembly document, directly involving the files changed in this PR.
• RHAI-ENG-105-llamastack changed install method #852: Updates the operator deployment method from "installed" to "activated," aligning with the prerequisite wording change in this PR.
• ENG-24976 - initial draft of documentation to configure milvus, kserv… #812: Introduces the original deployment modules and image references that this PR refines and updates.

Suggested reviewers

• jgarciao
• eturner24

Note

🔌 MCP (Model Context Protocol) integration is now available in Early Access!

Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context.

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1d463aa and c8c9509.

📒 Files selected for processing (1)

• modules/deploying-a-llamastackdistribution-instance.adoc (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• modules/deploying-a-llamastackdistribution-instance.adoc

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
• 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.

Support

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

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 docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for 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.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

modules/deploying-a-llama-model-with-kserve.adoc (1)

13-16: Anchor/terminology mismatch between “activated” wording and linked section

The prerequisite now says activated the Llama Stack Operator, but the link that follows still points to #installing-the-llama-stack-operator_rag.
Consider renaming the target anchor (and page heading) to activating for consistency, or adjust the prose here back to installed to avoid sending readers to a differently-worded section.

No functional impact, but improving this avoids cognitive friction.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 46e0e7e and be10050.

📒 Files selected for processing (2)

• modules/deploying-a-llama-model-with-kserve.adoc (1 hunks)
• modules/deploying-a-llamastackdistribution-instance.adoc (1 hunks)

🧰 Additional context used

🧠 Learnings (2)

📓 Common learnings

Learnt from: bredamc
PR: opendatahub-io/opendatahub-documentation#860
File: modules/using-llm-as-a-judge-metrics-with-lmeval.adoc:62-65
Timestamp: 2025-07-16T09:05:50.422Z
Learning: In the opendatahub-documentation project, bredamc prefers comprehensive error detection in code reviews. Continue to point out potential errors whether they are related to the code changes in the PR or not, but clearly distinguish between errors introduced in the PR versus errors in existing code.

📚 Learning: 2025-07-31T15:09:05.126Z

Learnt from: jiridanek
PR: opendatahub-io/opendatahub-documentation#888
File: modules/about-workbench-images.adoc:105-105
Timestamp: 2025-07-31T15:09:05.126Z
Learning: In the opendatahub-documentation project, ROCm workbench images come pre-integrated with additional frameworks and dependencies that users can utilize, rather than requiring users to integrate frameworks themselves. When describing these images, the focus should be on the pre-integrated capabilities rather than user integration tasks.

Applied to files:

• modules/deploying-a-llamastackdistribution-instance.adoc