Updated to clarify HolmesGPT references from Robusta #1916
Conversation
WalkthroughDocumentation updates reorient HolmesGPT guidance toward Robusta Helm chart configuration, add a new HolmesGPT docs page, adjust links and “Next Steps” items, and add AI analysis references. Index now points to the internal HolmesGPT docs. No code or API changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Pre-merge checks (1 passed, 1 warning, 1 inconclusive)❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (1 passed)
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. ✨ Finishing Touches🧪 Generate unit tests
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. Comment |
![coderabbitai[bot]](https://waps.l3s.uni-hannover.de/live/im_/https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/setup-robusta/installation/standalone-installation.rst (1)
16-16: Fix wrong anchor label for all-in-one install.The defined label is
install-all-in-one(see all-in-one page). Current link targetsinstall-with-prometheuswhich likely doesn’t exist.- If you're looking for standalone open source monitoring, you should install Robusta with Prometheus using the :ref:`all-in-one installation <install-with-prometheus>` instead. + If you're looking for standalone open source monitoring, you should install Robusta with Prometheus using the :ref:`all-in-one installation <install-all-in-one>` instead.docs/configuration/holmesgpt/getting-started.rst (1)
126-133: Add missing Helm values and template support for HolmesGPT Bedrock options
- In
helm/robusta/values.yaml, declare defaults for theholmesblock:holmes: enablePostProcessing: false additionalEnvVars: []- In
helm/robusta/templates/runner.yaml(around line 105), wrap post-processing logic in anif .Values.holmes.enablePostProcessingblock and inject.Values.holmes.additionalEnvVarsas environment variables.
🧹 Nitpick comments (5)
docs/configuration/holmesgpt/main-features.rst (1)
77-78: Clarify Helm-first guidance inline.The parenthetical “(use Robusta Helm Chart configuration method)” is easy to miss. Consider linking to the internal HolmesGPT docs hub for Helm-first context.
-* `Available Data Sources <https://holmesgpt.dev/data-sources/builtin-toolsets/>`_ - See all supported integrations (use Robusta Helm Chart configuration method) +* `Available Data Sources <https://holmesgpt.dev/data-sources/builtin-toolsets/>`_ - See all supported integrations (configure via Helm; see :doc:`HolmesGPT Docs </configuration/holmesgpt/holmesgpt-docs>`)docs/setup-robusta/installation/standalone-installation.rst (1)
10-10: Minor copy tweak (optional).Hyphenate “AI-powered” for consistency across docs.
-... for comprehensive AI-powered investigation and automation capabilities. +... for comprehensive AI-powered investigation and automation capabilities.(No change if you already standardize elsewhere.)
docs/configuration/holmesgpt/getting-started.rst (1)
174-175: Helpful pointer; consider adding an internal cross-link.Add a quick link to the internal HolmesGPT docs hub alongside the external data-sources page.
- - Enable additional data sources in `HolmesGPT data sources <https://holmesgpt.dev/data-sources/builtin-toolsets/>`_ (follow Helm chart configuration examples) + - Enable additional data sources in `HolmesGPT data sources <https://holmesgpt.dev/data-sources/builtin-toolsets/>`_ (follow Helm chart configuration examples; see also :doc:`HolmesGPT Docs </configuration/holmesgpt/holmesgpt-docs>`)docs/configuration/holmesgpt/holmesgpt-docs.rst (2)
1-2: Add a label so other pages can:ref:this hub page.This enables stable intra-doc links.
+.. _holmesgpt-docs: + HolmesGPT Documentation ========================
13-15: Scope the “advanced settings” phrasing.Consider clarifying that the Helm Configuration Reference is hosted on holmesgpt.dev and is the canonical source, to reduce duplication expectations in Robusta docs.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
docs/configuration/holmesgpt/getting-started.rst(2 hunks)docs/configuration/holmesgpt/holmesgpt-docs.rst(1 hunks)docs/configuration/holmesgpt/main-features.rst(1 hunks)docs/index.rst(1 hunks)docs/setup-robusta/installation/all-in-one-installation.rst(1 hunks)docs/setup-robusta/installation/extend-prometheus-installation.rst(1 hunks)docs/setup-robusta/installation/standalone-installation.rst(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: run_tests
- GitHub Check: run_tests
- GitHub Check: Deploy docs
🔇 Additional comments (4)
docs/configuration/holmesgpt/getting-started.rst (3)
46-49: Good call-out on Helm-first approach.The note clearly steers users to Helm-based configuration. Looks good.
114-114: Azure token limit phrasing.“Increase your deployment's token limit to at least 450K.” Double-check the exact Azure OpenAI UI wording (tokens per minute vs. context window vs. rate limits) to avoid confusion.
Please verify against current Azure OpenAI portal terminology.
182-183: Nice “Next Steps”.The Helm Configuration Reference link is a good addition.
docs/index.rst (1)
75-78: Good internalization of HolmesGPT docs.Pointing the AI Analysis section to the internal hub improves discoverability.
No description provided.