doc improvments - #1371
doc improvments#1371
Conversation
This analysis identifies 14 specific areas where HolmesGPT docs can be made more concise and clear, including: - Critical: Fix broken navigation references (3 non-existent files) - High priority: Reduce repetition in CLI installation (33% word reduction) - High priority: Convert verbose config to tables (25% reduction) - High priority: Shorten overly long interactive mode examples (37% reduction) - Medium priority: Improve data sources index and other sections Each recommendation includes exact file locations, before/after examples, and estimated impact on readability and maintenance. Signed-off-by: Claude <noreply@anthropic.com>
1. Convert Prometheus verbose config explanations to concise table format - Changed from 250+ word bullet list to scannable table - Maintains all information in more accessible format 2. Remove duplicate model selection note in Anthropic docs - Was repeated at lines 18 and 107 - Keep only at line 18 for clarity 3. Remove redundant usage examples from environment variables doc - Usage examples section repeated configuration from earlier sections - Provider-specific details already covered in AI Providers docs Signed-off-by: Claude <noreply@anthropic.com>
✅ Deploy Preview for holmes-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
📂 Previous Runs📜 Run @ a61eb7e (#21212172609)✅ Results of HolmesGPT evalsAutomatically triggered by commit a61eb7e on branch Results of HolmesGPT evals
Time/Cost columns show % change vs historical average (↑slower/costlier, ↓faster/cheaper). Changes under 10% shown as ±0%. Historical Comparison DetailsFilter: excluding branch 'claude/improve-docs-clarity-fu94h' Status: Success - 32 test/model combinations loaded Experiments compared (30):
Comparison indicators:
📜 Run @ baec590 (#21211949044)✅ Results of HolmesGPT evalsAutomatically triggered by commit baec590 on branch Results of HolmesGPT evals
Time/Cost columns show % change vs historical average (↑slower/costlier, ↓faster/cheaper). Changes under 10% shown as ±0%. Historical Comparison DetailsFilter: excluding branch 'claude/improve-docs-clarity-fu94h' Status: Success - 29 test/model combinations loaded Experiments compared (30):
Comparison indicators:
📜 Run @ 6069e57 (#21211323968)✅ Results of HolmesGPT evalsAutomatically triggered by commit 6069e57 on branch Results of HolmesGPT evals
Time/Cost columns show % change vs historical average (↑slower/costlier, ↓faster/cheaper). Changes under 10% shown as ±0%. Historical Comparison DetailsFilter: excluding branch 'claude/improve-docs-clarity-fu94h' Status: Success - 35 test/model combinations loaded Experiments compared (30):
Comparison indicators:
📜 Run @ adac44f (#21211124392)✅ Results of HolmesGPT evalsAutomatically triggered by commit adac44f on branch Results of HolmesGPT evals
Time/Cost columns show % change vs historical average (↑slower/costlier, ↓faster/cheaper). Changes under 10% shown as ±0%. Historical Comparison DetailsFilter: excluding branch 'claude/improve-docs-clarity-fu94h' Status: Success - 28 test/model combinations loaded Experiments compared (30):
Comparison indicators:
📜 Run @ 53fb18f (#21210889983)✅ Results of HolmesGPT evalsAutomatically triggered by commit 53fb18f on branch Results of HolmesGPT evals
Time/Cost columns show % change vs historical average (↑slower/costlier, ↓faster/cheaper). Changes under 10% shown as ±0%. Historical Comparison DetailsFilter: excluding branch 'claude/improve-docs-clarity-fu94h' Status: Success - 11 test/model combinations loaded Experiments compared (30):
Comparison indicators:
✅ Results of HolmesGPT evalsAutomatically triggered by commit da03888 on branch Results of HolmesGPT evals
Historical comparison unavailable: No experiments found (excluding branch 'claude/improve-docs-clarity-fu94h') Historical Comparison DetailsFilter: excluding branch 'claude/improve-docs-clarity-fu94h' Status: No experiments found (excluding branch 'claude/improve-docs-clarity-fu94h') Comparison indicators:
📖 Legend
🔄 Re-run evals manually
Option 1: Comment on this PR with Or with more options (one per line): Run evals on a different branch (e.g., master) for comparison:
Quick re-run: Use Option 2: Trigger via GitHub Actions UI → "Run workflow" 🏷️ Valid markers
Commands: CLI: |
|
✅ Docker image ready for
Use this tag to pull the image for testing. 📋 Copy commandsgcloud auth configure-docker us-central1-docker.pkg.dev
docker pull us-central1-docker.pkg.dev/robusta-development/temporary-builds/holmes:b96de4f
docker tag us-central1-docker.pkg.dev/robusta-development/temporary-builds/holmes:b96de4f me-west1-docker.pkg.dev/robusta-development/development/holmes-dev:b96de4f
docker push me-west1-docker.pkg.dev/robusta-development/development/holmes-dev:b96de4fPatch Helm values in one line (choose the chart you use): HolmesGPT chart: helm upgrade --install holmesgpt ./helm/holmes \
--set registry=me-west1-docker.pkg.dev/robusta-development/development \
--set image=holmes-dev:b96de4fRobusta wrapper chart: helm upgrade --install robusta robusta/robusta \
--reuse-values \
--set holmes.registry=me-west1-docker.pkg.dev/robusta-development/development \
--set holmes.image=holmes-dev:b96de4f |
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughDocumentation-only updates across multiple provider and toolset pages: Anthropic CLI example inlined; Prometheus doc reorganized with options/capabilities and provider-specific sections; ASK_HOLMES_TEST_TYPE usage examples removed; small wording/spacing edits to GCP, GitHub (added Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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 |
1. Reorganize Prometheus doc structure - Move "Finding your Prometheus URL" from Troubleshooting to Configuration - This is setup information, not troubleshooting content 2. Fix MkDocs rendering issues - add missing blank lines - grafanaloki.md: Add blank line after "**Required:**" - github.md: Add blank line after "**Key Parameters:**" - gcp.md: Add blank lines after "**What's Included:**" and "**Security Boundaries:**" Per MkDocs requirements, lists must have blank line after bold text or headers Signed-off-by: Claude <noreply@anthropic.com>
The 'Using CLI Parameters' section was appearing as a standalone section outside the tabs. It should only appear in the Holmes CLI tab since it's CLI-specific information. Now it appears correctly within the CLI tab only. Signed-off-by: Claude <noreply@anthropic.com>
1. Remove 'Getting Started' section from builtin-toolsets index - Content was too generic and not actionable - Users can see available toolsets in the grid above 2. Add helpful link in Prometheus prerequisites - Links to 'Finding your Prometheus URL' section on same page - Makes it easier for users to find setup instructions Signed-off-by: Claude <noreply@anthropic.com>
1. Move Validation into Configuration section with separate CLI and Helm instructions
- Added curl example for Helm/in-cluster HTTP API validation
- Validation is deployment-method specific
2. Remove generic Troubleshooting section
- Removed 3 unhelpful generic bullets (connection refused, auth errors, etc.)
- These were obvious fluff without actionable guidance
3. Group provider-specific configs under 'Specific Providers' section
- Added new '## Specific Providers' section header
- Changed all provider sections from h2 (##) to h3 (###)
- Removed 'Configuration' suffix from all provider names:
* Coralogix Prometheus Configuration → Coralogix Prometheus
* AWS Managed Prometheus (AMP) Configuration → AWS Managed Prometheus (AMP)
* Google Managed Prometheus Configuration → Google Managed Prometheus
* Azure Managed Prometheus Configuration → Azure Managed Prometheus
* Grafana Cloud (Mimir) Configuration → Grafana Cloud (Mimir)
- Shorter, cleaner headers
Signed-off-by: Claude <noreply@anthropic.com>
aantn
changed the title
Removed generic marketing-style phrase about detection capabilities. Simple and direct is better. Signed-off-by: Claude <noreply@anthropic.com>
Integrated 'Test your connection' subsection into Configuration rather than having a separate Validation section. Now flows naturally: - Configuration - Finding your Prometheus URL - Test your connection (CLI users / Helm users) Changed labels from 'For CLI:' to 'CLI users:' and 'For Helm:' to 'Helm users (HTTP API):' for consistency and clarity. Signed-off-by: Claude <noreply@anthropic.com>
…ation 1. Moved test command directly after YAML config (CLI-focused) - Test command now appears immediately after configuration - Cleaner flow: configure → test → alternatives 2. Removed separate 'Test your connection' section - Removed both CLI and Helm (HTTP API) test examples - Helm users can refer to HTTP API docs if needed - Simpler, more focused on common CLI usage Signed-off-by: Claude <noreply@anthropic.com>
- Created tab structure for CLI and Helm installation methods - CLI tab includes: * Config file location (~/.holmes/config.yaml) * Test command for validation * Environment variable alternative - Helm tab includes only YAML config (no test command or env vars) - Keeps CLI-specific instructions separate from Helm deployment Signed-off-by: Claude <noreply@anthropic.com>
…Helm - Changed from 2 tabs (CLI/Helm) to 3 tabs to match Anthropic docs structure - Holmes CLI tab: includes config file location, test command, env var alternative - Holmes Helm Chart tab: YAML config only - Robusta Helm Chart tab: YAML config with 'holmes:' prefix - Test command and env vars only appear in CLI tab Signed-off-by: Claude <noreply@anthropic.com>
Changed from regular 'yaml' to 'yaml-toolset-config' code fence in the Holmes CLI tab. This provides proper syntax highlighting and formatting for toolset configuration, following the pattern used in other toolset docs like coralogix-logs.md. Content after the code fence (test command, env var alternative) still works as expected - yaml-toolset-config is just a regular code fence with special styling. Signed-off-by: Claude <noreply@anthropic.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/data-sources/builtin-toolsets/prometheus.md (2)
212-213: Add blank line after "Notes:" for proper list rendering.As per coding guidelines for MkDocs documentation, a blank line must be added between bold text and lists to ensure proper rendering.
📝 Proposed fix
**Notes:** + - The toolset automatically detects AWS configuration when `aws_region` is presentBased on coding guidelines: "Add blank line between header/bold text and a list in MkDocs documentation files, otherwise lists won't render properly"
272-273: Add blank line after "Notes:" for proper list rendering.As per coding guidelines for MkDocs documentation, a blank line must be added between bold text and lists to ensure proper rendering.
📝 Proposed fix
**Notes:** + - `prometheus_url` must point to the Azure Managed Prometheus workspace endpoint (include the trailing slash).Based on coding guidelines: "Add blank line between header/bold text and a list in MkDocs documentation files, otherwise lists won't render properly"
The yaml-toolset-config fence automatically creates 3 tabs, so it can't be used inside manual tab structures without creating double tabs. Since we need CLI-specific content (test command, env vars) in only the Holmes CLI tab, we must use manual tabs with regular yaml fences. Signed-off-by: Claude <noreply@anthropic.com>
- Use yaml-toolset-config fence to automatically generate 3 tabs - Remove CLI-specific test command and environment variable alternative - Cleaner, simpler configuration section - Users can test connection on their own after setup Signed-off-by: Claude <noreply@anthropic.com>
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/data-sources/builtin-toolsets/prometheus.md (2)
168-169: Missing blank line before list.Per the coding guidelines, MkDocs requires a blank line between bold text and a list for proper rendering.
📝 Proposed fix
**Notes:** + - The toolset automatically detects AWS configuration when `aws_region` is presentBased on coding guidelines: "Add blank line between header/bold text and a list in MkDocs documentation files, otherwise lists won't render properly"
228-231: Missing blank line before list.Per the coding guidelines, MkDocs requires a blank line between bold text and a list for proper rendering.
📝 Proposed fix
**Notes:** + - `prometheus_url` must point to the Azure Managed Prometheus workspace endpoint (include the trailing slash).Based on coding guidelines: "Add blank line between header/bold text and a list in MkDocs documentation files, otherwise lists won't render properly"
Reorganized Prometheus documentation structure: - Specific Providers section now comes before advanced topics - Advanced Configuration and Capabilities moved to end of document - Better flow: basic config → finding URL → specific providers → advanced options Signed-off-by: Claude <noreply@anthropic.com>
Changed 'Using a service principal (client secret)' from h3 to h4 heading. This makes it a subsection under 'Azure Managed Prometheus' instead of a sibling section, which is the correct hierarchy. Signed-off-by: Claude <noreply@anthropic.com>
3 participants
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.