More doc improvements#1890
Merged
Merged
Conversation
- Remove sinks/destinations from integrations overview - Restructure page to highlight "Forward Alerts to Robusta" - Add dedicated section for Prometheus, Nagios, and SolarWinds - Simplify description to focus on alert forwarding and AI analysis 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Move sinks reference from Integrations nav to Notifications & Routing nav - Place sinks as first item in Notifications & Routing section - Remove sinks from Integrations section to reduce confusion - Keep logical grouping of alert destinations with notification routing 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Redesign integrations overview to be truly high-level with categories - Rename "Integrating with Prometheus" to "Alert Sources" for broader scope - Remove duplicate content between overview and subpages - Focus overview on integration categories rather than detailed setup - Update navigation labels to match new page structure - Make user journey clearer: overview → specific alert source setup 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
… Automation - Rename "Integrations" section to "Alert Sources" - much clearer purpose - Create dedicated "AI Analysis" section for Holmes GPT only - Move KRR, Popeye, and data export to "Automation" section - Update Alert Sources overview to focus purely on monitoring integrations - Remove mixed content categories that confused users - Improve logical flow: Alert Sources → AI Analysis → Notifications → Automation 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Create new notifications overview page as entry point - Reorder navigation: Overview → Configuring Sinks → Sink Reference - Fix information hierarchy so users start with concepts, not specific sinks - Prevent sphinx menu expansion pushing basic setup pages down - Add clear getting started flow and common workflows - Update sink reference title to match new structure 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Move Nagios and SolarWinds from Prometheus subpages to top-level Alert Sources - Remove confusing navigation hierarchy where non-Prometheus systems appeared under Prometheus - Clean up Prometheus page to focus purely on Prometheus/AlertManager integrations - Remove "Other Alerting Systems" section since they're now top-level - Create clearer navigation: Overview → Prometheus → Nagios → SolarWinds 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Remove verbose explanations and get straight to the point - Lead with clear action: "Choose your monitoring system" - Make card descriptions more direct and useful - Add practical note about webhook compatibility for other systems - Cut word count by ~60% while improving clarity 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Change 'Legacy systems' to 'Nagios monitoring' - Change 'Enterprise monitoring' to 'SolarWinds monitoring' - Keep descriptions neutral and product-focused - Avoid terms that might make users feel bad about their tech choices 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Link 'HTTP webhooks' to webhook triggers documentation - Provides users with concrete next steps if their system isn't listed - Makes the fallback option actionable rather than just informational 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Link HTTP webhooks to exporting-data.rst which contains POST /api/alerts endpoint - This is the correct endpoint for sending alerts from any system via HTTP - Previous link was to webhook triggers which is for different use case 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Move exporting-data.rst from Automation to Alert Sources as "Custom Webhooks" - This contains the POST /api/alerts endpoint for sending alerts TO Robusta - Makes it discoverable for users wanting to integrate custom monitoring systems - Logical placement with other alert source integrations 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Remove navigation.tabs and navigation.tabs.sticky features - Add navigation.sections and navigation.expand for better sidebar - This provides more room for additional top-level sections - Makes navigation more scalable for future section additions 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
WalkthroughThe documentation was updated to improve clarity and accuracy. Code block names were revised in multiple files for better distinction, various link texts were clarified or corrected, minor formatting adjustments were made, and some textual content was refined for precision and readability. No functional or structural changes were made. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (6)
✅ Files skipped from review due to trivial changes (6)
⏰ 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)
✨ 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![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
🧹 Nitpick comments (1)
docs/notification-routing/disable-oomkill-notifications.rst (1)
11-11: Minor grammar polish for smoother readingDrop the extra “to” and add a comma after “Similarly” to improve flow:
-Similarly you can to disable any built-in notification using the name of the playbook. +Similarly, you can disable any built-in notification using the name of the playbook.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/how-it-works/alert-builtin-enrichment.rst(2 hunks)docs/index.rst(1 hunks)docs/notification-routing/disable-oomkill-notifications.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/how-it-works/alert-builtin-enrichment.rst (3)
28-30: Check for dangling references to the old code-block nameRenaming the block to
cb-apply-pendingpodis a good move for uniqueness.
Please grep the docs forcb-apply-crashpodto ensure no :ref: or xref links still target the old identifier.
35-37: Same verification needed after renaming tocb-trigger-prometheus-alertConfirm external references (e.g., in tutorials or blog posts) were updated or remain functional.
50-52: Third rename – double-check cross-doc linksAfter switching to
cb-apply-crashpod-apiserver, make sure any:name:links in Grafana dashboards or other docs point to this new id.docs/index.rst (1)
90-94: Bullet removal looks fineThe “Advanced Routing” item was removed, which keeps the list concise and avoids overlap with the dedicated “Routing (Scopes)” docs section. No issues spotted.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.