Skip to content

ROB-3785 Mark AlertManager integration docs as legacy#2082

Merged
naomi-robusta merged 3 commits into
masterfrom
claude/add-legacy-banner-BKHay
May 17, 2026
Merged

ROB-3785 Mark AlertManager integration docs as legacy#2082
naomi-robusta merged 3 commits into
masterfrom
claude/add-legacy-banner-BKHay

Conversation

@naomi-robusta
Copy link
Copy Markdown
Contributor

@naomi-robusta naomi-robusta commented May 17, 2026

image

Summary

This PR adds legacy deprecation warnings to AlertManager integration documentation and related exporting APIs, directing users to the newer Send Events API for new integrations.

Key Changes

  • Created a new reusable _legacy_banner.rst file containing a deprecation warning that references the Send Events API
  • Added the legacy banner include to all AlertManager integration documentation files:
    • Alert Manager (in-cluster and external)
    • Cloud provider integrations (Azure, AWS, GCP, Coralogix)
    • Monitoring platforms (Dynatrace, Grafana, Nagios, New Relic, SolarWinds, VictoriaMetrics)
    • Google Managed Alertmanager
  • Added the legacy banner to related exporting APIs:
    • Configuration Changes API
    • Custom Webhooks
    • Send Alerts API

Implementation Details

The deprecation banner is implemented as a reusable RST include file that can be easily maintained in one location. This approach ensures consistent messaging across all legacy features and makes it simple to update the deprecation notice in the future if needed.

https://claude.ai/code/session_01HPM81GrhcqWdvYgke5aGDt

Each page under the "Send Alerts to Robusta" section now displays a
warning at the top noting that the section is legacy and pointing
readers to the new Send Events API.

https://claude.ai/code/session_01HPM81GrhcqWdvYgke5aGDt
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 17, 2026

Docker image ready for 36d38fd (built in 2m 51s)

⚠️ 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:36d38fd
docker tag us-central1-docker.pkg.dev/robusta-development/temporary-builds/robusta-runner:36d38fd me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:36d38fd
docker push me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:36d38fd

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:36d38fd

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 17, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2f881059-b98b-48af-bb2c-bad402f61272

📥 Commits

Reviewing files that changed from the base of the PR and between e5f17ae and 4043bc9.

📒 Files selected for processing (1)
  • docs/configuration/index.rst
✅ Files skipped from review due to trivial changes (1)
  • docs/configuration/index.rst

Walkthrough

Creates a shared reStructuredText legacy warning include and prepends it to 22 alerting and exporting integration documentation pages to mark those integrations as legacy and point readers to the Send Events API.

Changes

Legacy Integration Banner Implementation

Layer / File(s) Summary
Shared legacy banner template
docs/configuration/_legacy_banner.rst
A .. warning:: directive is added that marks the feature as legacy and references the Send Events API documentation for new integrations.
Apply banner to alertmanager integration guides
docs/configuration/alertmanager-integration/alert-manager.rst, azure-managed-prometheus.rst, coralogix_managed_prometheus.rst, customize-labels-priorities.rst, dynatrace.rst, eks-managed-prometheus.rst, embedded-prometheus.rst, gcp-monitoring.rst, google-managed-alertmanager.rst, google-managed-prometheus.rst, grafana-cloud.rst, grafana-self-hosted.rst, nagios.rst, newrelic.rst, outofcluster-prometheus.rst, pagerduty-alerting.rst, solarwinds.rst, victoria-metrics.rst
Prepends .. include:: ../_legacy_banner.rst to 18 alertmanager integration guides so the legacy banner renders at the top of each page.
Apply banner to exporting guides and config index
docs/configuration/exporting/configuration-changes-api.rst, custom-webhooks.rst, send-alerts-api.rst, docs/configuration/index.rst
Adds .. include:: ../_legacy_banner.rst (or ./_legacy_banner.rst for index) at the start of exporting integration pages and the configuration index.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • robusta-dev/robusta#2068: Edits the same docs/configuration/exporting/send-alerts-api.rst page; content overlap with banner insertion.
  • robusta-dev/robusta#1990: Modifies Google Alertmanager/Prometheus docs, overlapping pages where the banner was added.
  • robusta-dev/robusta#1858: Changes the Coralogix Managed Prometheus doc that also received the legacy banner include.

Suggested reviewers

  • moshemorad
  • aantn
  • RoiGlinik
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically identifies the main change: marking AlertManager integration documentation as legacy.
Description check ✅ Passed The description is directly related to the changeset, explaining the purpose (adding legacy warnings), the new file created, and all affected documentation files.
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/add-legacy-banner-BKHay

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.

❤️ Share

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

@naomi-robusta naomi-robusta requested review from aantn and moshemorad May 17, 2026 14:17
@naomi-robusta naomi-robusta enabled auto-merge (squash) May 17, 2026 14:17
@naomi-robusta naomi-robusta changed the title Mark AlertManager integration docs as legacy ROB-3785 Mark AlertManager integration docs as legacy May 17, 2026
@naomi-robusta naomi-robusta merged commit ac01bc2 into master May 17, 2026
5 checks passed
@naomi-robusta naomi-robusta deleted the claude/add-legacy-banner-BKHay branch May 17, 2026 14:51
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