Skip to content

Add deprecation notices to legacy sink documentation pages#2097

Merged
aantn merged 10 commits into
masterfrom
claude/tender-heisenberg-R1T4Z
Jun 4, 2026
Merged

Add deprecation notices to legacy sink documentation pages#2097
aantn merged 10 commits into
masterfrom
claude/tender-heisenberg-R1T4Z

Conversation

@aantn

@aantn aantn commented Jun 3, 2026

Copy link
Copy Markdown
Collaborator

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

  • Added warning admonitions to the top of 24 sink documentation files
  • Two variants of deprecation notices:
    • Slack & MS Teams: Directs users to connect HolmesGPT directly via the Robusta platform settings page, highlighting agentic alert investigation and routing capabilities
    • All other sinks: Generic deprecation notice recommending HolmesGPT as a replacement, explaining the shift from static notification forwarding to intelligent agentic alert handling

Implementation Details

  • Warnings are implemented as reStructuredText admonition directives with the warning class for consistent styling
  • Slack and MS Teams notices include specific platform links and mention MCP servers for enhanced context
  • All notices emphasize the benefits of agentic decision-making over blind notification forwarding
  • Notices are placed immediately after the page title, before existing content, ensuring high visibility

https://claude.ai/code/session_017Rj9Tk6fmiMaeCQvZzuvtp

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.
@github-actions

github-actions Bot commented Jun 3, 2026

Copy link
Copy Markdown

Docker image ready for 5397bb2 (built in 40s)

⚠️ Warning: does not support ARM (ARM images are built on release only - not on every PR)

Use this tag to pull the image for testing.

📋 Copy commands

⚠️ Temporary images are deleted after 30 days. Copy to a permanent registry before using them:

gcloud 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:5397bb2

Patch 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

@coderabbitai

coderabbitai Bot commented Jun 3, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It 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 reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

Walkthrough

Adds 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.

Changes

Sink Deprecation Documentation

Layer / File(s) Summary
Collaboration sink legacy notices
docs/configuration/sinks/discord.rst, docs/configuration/sinks/google_chat.rst, docs/configuration/sinks/mattermost.rst, docs/configuration/sinks/ms-teams.rst, docs/configuration/sinks/slack.rst, docs/configuration/sinks/rocketchat.rst, docs/configuration/sinks/telegram.rst, docs/configuration/sinks/webex.rst, docs/configuration/sinks/zulip.rst, docs/configuration/sinks/YandexMessenger.rst
Inserted top-of-page Sphinx warning admonitions marking these chat/collaboration sinks as legacy and directing users to HolmesGPT or platform chat integrations; existing setup content unchanged.
Incident & ticketing sink legacy notices
docs/configuration/sinks/Opsgenie.rst, docs/configuration/sinks/PagerDuty.rst, docs/configuration/sinks/ServiceNow.rst, docs/configuration/sinks/jira.rst, docs/configuration/sinks/VictorOps.rst
Added warning admonitions labeling these incident/ticketing sinks as legacy and contrasting static forwarding with agentic, workflow-driven alert triage.
Delivery and transport sink legacy notices
docs/configuration/sinks/DataDog.rst, docs/configuration/sinks/file.rst, docs/configuration/sinks/kafka.rst, docs/configuration/sinks/mail.rst, docs/configuration/sinks/pushover.rst, docs/configuration/sinks/webhook.rst
Added top-of-page warning admonitions marking these delivery/transport/generic sinks as legacy and recommending HolmesGPT; rest of pages remain unchanged.
Sinks index and related docs
docs/configuration/sinks/index.rst, docs/notification-routing/configuring-sinks.rst, docs/configuration/alertmanager-integration/launchdarkly.rst
Added a sinks legacy admonition/banner to the sinks index and configuring-sinks guidance, and included a legacy banner include on the LaunchDarkly integration page.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

  • moshemorad
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Add deprecation notices to legacy sink documentation pages' accurately and specifically summarizes the main change: adding deprecation warnings to sink documentation files.
Description check ✅ Passed The description clearly explains the purpose (guiding users to HolmesGPT), changes made (warning admonitions to 24 files), implementation details (reStructuredText directives), and the distinction between Slack/MS Teams and other sinks.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/tender-heisenberg-R1T4Z

Comment @coderabbitai help to get the list of available commands and usage tips.

claude added 3 commits June 3, 2026 20:38
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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 | 🟠 Major

Fix broken documentation links in docs/configuration/sinks/mattermost.rst deprecation notice

  • https://holmesgpt.dev/data-sources/remote-mcp-servers/?tab=robusta-helm-chart returns 404
  • https://platform.robusta.dev/holmes/alerts-triage returns 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

📥 Commits

Reviewing files that changed from the base of the PR and between e46c7e2 and a83fe3d.

📒 Files selected for processing (21)
  • docs/configuration/sinks/DataDog.rst
  • docs/configuration/sinks/Opsgenie.rst
  • docs/configuration/sinks/PagerDuty.rst
  • docs/configuration/sinks/ServiceNow.rst
  • docs/configuration/sinks/VictorOps.rst
  • docs/configuration/sinks/YandexMessenger.rst
  • docs/configuration/sinks/discord.rst
  • docs/configuration/sinks/file.rst
  • docs/configuration/sinks/google_chat.rst
  • docs/configuration/sinks/jira.rst
  • docs/configuration/sinks/kafka.rst
  • docs/configuration/sinks/mail.rst
  • docs/configuration/sinks/mattermost.rst
  • docs/configuration/sinks/ms-teams.rst
  • docs/configuration/sinks/pushover.rst
  • docs/configuration/sinks/rocketchat.rst
  • docs/configuration/sinks/slack.rst
  • docs/configuration/sinks/telegram.rst
  • docs/configuration/sinks/webex.rst
  • docs/configuration/sinks/webhook.rst
  • docs/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

claude added 6 commits June 3, 2026 20:45
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.
@aantn aantn enabled auto-merge (squash) June 4, 2026 17:59
@aantn aantn merged commit bbb7481 into master Jun 4, 2026
8 of 9 checks passed
@aantn aantn deleted the claude/tender-heisenberg-R1T4Z branch June 4, 2026 18:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants