Docs: clarify holmes saas dependence

[aantn]

Summary by CodeRabbit

• Documentation
  • Updated HolmesGPT integration guide to clarify that a Robusta SaaS account and UI sink are currently required.
  • Marked HolmesGPT SaaS data access configuration as a mandatory setup step.
  • Added a note about planned future support for open-source mode.

[coderabbitai]

Walkthrough

The documentation for HolmesGPT integration was updated to clarify that a Robusta SaaS account and the Robusta UI sink are currently required. The step for configuring HolmesGPT access to SaaS data is now marked as mandatory, and a note was added about planned future support for pure OSS mode.

Changes

File	Change Summary
docs/configuration/holmesgpt/index.rst	Updated documentation to clarify SaaS requirements, made SaaS data access configuration mandatory, and added note about future OSS support.

Sequence Diagram(s)

No sequence diagram generated as the changes are limited to documentation updates.

Suggested reviewers

• Sheeproid
• arikalon1

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1f1c136 and 692d467.

📒 Files selected for processing (1)

• docs/configuration/holmesgpt/index.rst (2 hunks)

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

• docs/configuration/holmesgpt/index.rst

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: run_tests
• GitHub Check: run_tests
• GitHub Check: Deploy docs

---

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.
  • @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 docstrings to generate docstrings for this 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.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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: 0

🧹 Nitpick comments (2)

docs/configuration/holmesgpt/index.rst (2)

19-19: Enhance clarity of requirement statement
The sentence is lengthy and encloses future plans in parentheses, which may reduce readability. Consider splitting into two sentences and using parallel structure to clearly convey the current requirements and upcoming OSS support. For example:

- This requires a Robusta SaaS account, and for the Robusta UI sink to be enabled. (We have plans to support HolmesGPT in a pure OSS mode in the near future. Stay tuned!)
+ This integration currently requires both a Robusta SaaS account and the Robusta UI sink to be enabled.
+
+ We plan to support HolmesGPT in pure OSS mode in the near future—stay tuned!

---

40-40: Verify cross-reference anchoring for the new step
The :ref: link to Configuring HolmesGPT Access to SaaS Data assumes that section has a resolvable label. Ensure you’ve either enabled autosectionlabel in conf.py or added an explicit anchor above the heading, for example:

.. _configuring-holmesgpt-access-to-saas-data:

Configuring HolmesGPT Access to SaaS Data
------------------------------------------

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 55124a8 and 1f1c136.

📒 Files selected for processing (1)

• docs/configuration/holmesgpt/index.rst (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: run_tests
• GitHub Check: run_tests
• GitHub Check: Deploy docs

[pavangudiwada]

LGTM