Add deprecation notices to legacy sink documentation pages#2097
Conversation
Add a prominent banner to every sink page noting it documents a legacy sink in Robusta classic. Users are directed to HolmesGPT, which uses triggered workflows + MCP servers to investigate and route alerts agentically instead of statically forwarding notifications. For Slack and MS Teams, point users at the platform Slack & Teams settings page to connect HolmesGPT directly.
|
✅ 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/robusta-runner:5397bb2
docker tag us-central1-docker.pkg.dev/robusta-development/temporary-builds/robusta-runner:5397bb2 me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:5397bb2
docker push me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:5397bb2Patch Helm values in one line: helm upgrade --install robusta robusta/robusta \
--reuse-values \
--set runner.image=me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:5397bb2 |
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughAdds top-of-page Sphinx warning admonitions to sink docs and related pages marking sinks as legacy "Robusta classic", directing readers to HolmesGPT, Alerts Triage, or Triggered Workflows; no code changes. ChangesSink Deprecation Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Remove the disparaging 'instead of blindly forwarding' clause from the legacy sink banners; close positively on intelligent per-alert triage.
Reference both the triggered workflows page and the platform alert triage page (platform.robusta.dev/holmes/alerts-triage) as ways to set up agentic alert routing.
Change opener from 'You probably want...' to 'For new setups, we recommend...' for a more positive, forward-looking tone.
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/configuration/sinks/mattermost.rst (1)
4-10:⚠️ Potential issue | 🟠 MajorFix broken documentation links in
docs/configuration/sinks/mattermost.rstdeprecation notice
https://holmesgpt.dev/data-sources/remote-mcp-servers/?tab=robusta-helm-chartreturns 404https://platform.robusta.dev/holmes/alerts-triagereturns 404
(:ref:\defining-playbooks`exists indocs/playbook-reference/defining-playbooks/index.rst`.)🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/configuration/sinks/mattermost.rst` around lines 4 - 10, Update the deprecation/admonition block in the Mattermost sink doc: replace the broken external URLs `https://holmesgpt.dev/data-sources/remote-mcp-servers/?tab=robusta-helm-chart` and `https://platform.robusta.dev/holmes/alerts-triage` with valid targets (or remove them) and ensure the internal cross-reference uses the existing playbook ref `:ref:\`defining-playbooks\``; specifically edit the admonition paragraph that currently mentions `HolmesGPT <https://holmesgpt.dev/>`_, the `MCP servers <https://holmesgpt.dev/data-sources/remote-mcp-servers/?tab=robusta-helm-chart>`_ link and the `alert triage <https://platform.robusta.dev/holmes/alerts-triage>`_ link so they point to working pages (or to the correct docs paths) while keeping the `:ref:\`triggered workflows <defining-playbooks>\`` reference intact.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@docs/configuration/sinks/mattermost.rst`:
- Around line 4-10: Update the deprecation/admonition block in the Mattermost
sink doc: replace the broken external URLs
`https://holmesgpt.dev/data-sources/remote-mcp-servers/?tab=robusta-helm-chart`
and `https://platform.robusta.dev/holmes/alerts-triage` with valid targets (or
remove them) and ensure the internal cross-reference uses the existing playbook
ref `:ref:\`defining-playbooks\``; specifically edit the admonition paragraph
that currently mentions `HolmesGPT <https://holmesgpt.dev/>`_, the `MCP servers
<https://holmesgpt.dev/data-sources/remote-mcp-servers/?tab=robusta-helm-chart>`_
link and the `alert triage <https://platform.robusta.dev/holmes/alerts-triage>`_
link so they point to working pages (or to the correct docs paths) while keeping
the `:ref:\`triggered workflows <defining-playbooks>\`` reference intact.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 61e77aed-ff7d-4b17-abca-8fe70c340ce0
📒 Files selected for processing (21)
docs/configuration/sinks/DataDog.rstdocs/configuration/sinks/Opsgenie.rstdocs/configuration/sinks/PagerDuty.rstdocs/configuration/sinks/ServiceNow.rstdocs/configuration/sinks/VictorOps.rstdocs/configuration/sinks/YandexMessenger.rstdocs/configuration/sinks/discord.rstdocs/configuration/sinks/file.rstdocs/configuration/sinks/google_chat.rstdocs/configuration/sinks/jira.rstdocs/configuration/sinks/kafka.rstdocs/configuration/sinks/mail.rstdocs/configuration/sinks/mattermost.rstdocs/configuration/sinks/ms-teams.rstdocs/configuration/sinks/pushover.rstdocs/configuration/sinks/rocketchat.rstdocs/configuration/sinks/slack.rstdocs/configuration/sinks/telegram.rstdocs/configuration/sinks/webex.rstdocs/configuration/sinks/webhook.rstdocs/configuration/sinks/zulip.rst
✅ Files skipped from review due to trivial changes (15)
- docs/configuration/sinks/zulip.rst
- docs/configuration/sinks/google_chat.rst
- docs/configuration/sinks/file.rst
- docs/configuration/sinks/webex.rst
- docs/configuration/sinks/DataDog.rst
- docs/configuration/sinks/PagerDuty.rst
- docs/configuration/sinks/VictorOps.rst
- docs/configuration/sinks/rocketchat.rst
- docs/configuration/sinks/ms-teams.rst
- docs/configuration/sinks/slack.rst
- docs/configuration/sinks/Opsgenie.rst
- docs/configuration/sinks/discord.rst
- docs/configuration/sinks/ServiceNow.rst
- docs/configuration/sinks/YandexMessenger.rst
- docs/configuration/sinks/telegram.rst
🚧 Files skipped from review as they are similar to previous changes (3)
- docs/configuration/sinks/pushover.rst
- docs/configuration/sinks/kafka.rst
- docs/configuration/sinks/webhook.rst
Drop the MCP servers reference (confusing in this context) and point users to Alerts Triage for alerts or Triggered Workflows for custom events. Also resolves the stale MCP-servers doc link.
Say just 'Slack' on the Slack page and 'MS Teams' on the Teams page instead of 'Slack and Teams' (the shared settings URL still covers both).
…hDarkly - Sinks index and configuring-sinks: point users to HolmesGPT (Alerts Triage / Triggered Workflows), matching the per-sink banners. - LaunchDarkly: reuse the shared _legacy_banner include pointing to the Send Events API, consistent with sibling alertmanager-integration pages.
Separate the three flows that share one HolmesGPT bot: interactive chat (@mention), automatic Alerts Triage for alerts, and Triggered Workflows for custom events — instead of conflating them.
- region_box: support :emphasize-lines: on the robusta-code directive (fixes 'maximum 1 argument(s) allowed' error in elasticsearch.rst) - proxies: extend a section underline that was too short - RobustaUI sink: drop outdated/k8s-specific overview and the loom gif, point to home.robusta.dev, and note that the namespace/cluster monitoring features are Robusta classic (not HolmesGPT)
Replace the abstract 'statically forward / agentically' wording with a benefits-first explanation: HolmesGPT triages alerts (investigates, finds root cause, escalates only what matters) vs. deterministic sinks that just forward everything. Then point to Alerts Triage / Triggered Workflows.
Summary
Added deprecation warnings to all sink documentation pages to guide users toward HolmesGPT as the modern alternative to the legacy Robusta classic sinks.
Changes
Implementation Details
admonitiondirectives with thewarningclass for consistent stylinghttps://claude.ai/code/session_017Rj9Tk6fmiMaeCQvZzuvtp