ROB-3785 Reorganize webhook documentation under new webhooks directory#2080
ROB-3785 Reorganize webhook documentation under new webhooks directory#2080naomi-robusta wants to merge 1 commit into
Conversation
Move the webhooks documentation tree from `configuration/exporting/send-events*` to `configuration/webhooks/*` so the URL matches the underlying endpoint. The Send Events API page is now the parent and links to two children: - Send Alerts API (`webhooks/send-alerts-api.rst`) hosts the 14 existing alert origin pages, now under `webhooks/alerts/`. - Send Changes API (`webhooks/send-changes-api.rst`) is new and documents the LaunchDarkly, Argo CD, and GitHub change webhooks under `webhooks/changes/`. The Send Events API page itself mentions both alerts and changes and points at the relevant child. The two ``incident`` references were dropped from user-facing copy since we don't support that type yet. https://claude.ai/code/session_017jWTUJW4HMfCYk3AX3DZ84
|
✅ 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:3951d1f
docker tag us-central1-docker.pkg.dev/robusta-development/temporary-builds/robusta-runner:3951d1f me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:3951d1f
docker push me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:3951d1fPatch 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:3951d1f |
WalkthroughThis PR restructures Robusta's webhook documentation by relocating the unified "Send Events API" documentation from ChangesWebhook API Documentation Reorganization
Change Event Integration Guides
Sequence Diagram(s)No sequence diagrams generated; this PR is primarily documentation restructuring without functional code changes or multi-component interactions. Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
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)
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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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.
Inline comments:
In `@docs/configuration/webhooks/changes/github.rst`:
- Around line 20-46: The doc currently instructs users to complete webhook steps
1–7 (including "Save") before showing the required token parameter, which causes
them to save an unauthenticated webhook; move the explanation/example that
includes the token (the code-block containing &token=<ROBUSTA_API_KEY> and the
phrase "Pass the Robusta API key on the URL instead") so it appears before or
within step 2 (the "Payload URL" instruction) and update the initial example URL
shown at the top to include &token=<ROBUSTA_API_KEY>; ensure references to
"Payload URL" and the token parameter remain clear so users include the token
when they paste the URL.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 72eba4f8-f0fc-4fa6-bb2f-ddb824cf88e8
📒 Files selected for processing (23)
docs/configuration/exporting/send-events-api.rstdocs/configuration/index.rstdocs/configuration/webhooks/alerts/alertmanager.rstdocs/configuration/webhooks/alerts/aws-cloudwatch.rstdocs/configuration/webhooks/alerts/azure-monitor.rstdocs/configuration/webhooks/alerts/datadog.rstdocs/configuration/webhooks/alerts/dynatrace.rstdocs/configuration/webhooks/alerts/gcp-monitoring.rstdocs/configuration/webhooks/alerts/grafana.rstdocs/configuration/webhooks/alerts/nagios.rstdocs/configuration/webhooks/alerts/newrelic.rstdocs/configuration/webhooks/alerts/opsgenie.rstdocs/configuration/webhooks/alerts/pagerduty.rstdocs/configuration/webhooks/alerts/sentry.rstdocs/configuration/webhooks/alerts/solarwinds.rstdocs/configuration/webhooks/alerts/splunk.rstdocs/configuration/webhooks/changes/argocd.rstdocs/configuration/webhooks/changes/github.rstdocs/configuration/webhooks/changes/launchdarkly.rstdocs/configuration/webhooks/send-alerts-api.rstdocs/configuration/webhooks/send-changes-api.rstdocs/configuration/webhooks/send-events-api.rstdocs/index.rst
💤 Files with no reviewable changes (1)
- docs/configuration/exporting/send-events-api.rst
Summary
Restructured the webhook integration documentation to create a unified "Send Events API" framework that encompasses both alerts and configuration changes. This improves the information architecture by consolidating related webhook integrations under a single parent concept.
Key Changes
Reorganized directory structure: Moved webhook documentation from
docs/configuration/exporting/todocs/configuration/webhooks/webhooks/directory withsend-events-api.rstas the parent documentsend-alerts-api.rstandsend-changes-api.rstExpanded Send Events API: Enhanced the parent API documentation to cover both alert and change event types
type=alertandtype=change)&token=) for vendors that cannot send custom headersAdded new change event integrations: Created documentation for three new change event sources
changes/launchdarkly.rst- Feature flag change trackingchanges/argocd.rst- GitOps deployment trackingchanges/github.rst- Code change and deployment trackingReorganized alert integrations: Moved existing alert integrations from
send-events/toalerts/subdirectorysend-alerts-api.rstto reference the parentsend-events-api.rstfor common parametersUpdated navigation: Modified
docs/configuration/index.rstanddocs/index.rstto reference new webhook pathsNotable Implementation Details
https://claude.ai/code/session_017jWTUJW4HMfCYk3AX3DZ84