Skip to content

docs: small cleanups in webhook examples - #5498

Open
SoloJacobs wants to merge 1 commit into
prometheus:mainfrom
SoloJacobs:goat
Open

docs: small cleanups in webhook examples#5498
SoloJacobs wants to merge 1 commit into
prometheus:mainfrom
SoloJacobs:goat

Conversation

@SoloJacobs

Copy link
Copy Markdown
Contributor

Just a bit of cleanup after #5408
Old:
image

New:
image

Pull Request Checklist

Which user-facing changes does this PR introduce?

NONE

* Just a bit of formatting to make the text more readable.
* The Gotify example referenced a header, it did not use.
* We only have two examples, so I felt that we shouldn't hint at
more examples, where there aren't any.

Signed-off-by: Solomon Jacobs <solomonjacobs@protonmail.com>
@SoloJacobs
SoloJacobs marked this pull request as ready for review August 30, 2026 18:08
@SoloJacobs
SoloJacobs requested a review from a team as a code owner August 30, 2026 18:08
@coderabbitai

coderabbitai Bot commented Aug 30, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 9d667b93-dc90-4c3e-8f06-41107716f41c

📥 Commits

Reviewing files that changed from the base of the PR and between ad686cf and 0d44ba0.

📒 Files selected for processing (3)
  • docs/configuration.md
  • docs/notification_examples.md
  • examples/webhook/gotify.yml

Included review availability: Your plan provides up to 8 included reviews per hour; 7 remain after this review.


📝 Walkthrough

Walkthrough

The PR updates the Gotify webhook message template and related documentation. It adds structured alert headings and details, formats timestamps, changes alert checks, removes obsolete authentication text, and revises the Microsoft Teams example reference.

Changes

Gotify webhook documentation

Layer / File(s) Summary
Update Gotify webhook template and documentation
examples/webhook/gotify.yml, docs/notification_examples.md, docs/configuration.md
The Gotify template adds headings, formatted timestamps, Markdown list items, and direct firing/resolved alert checks. The documentation removes the X-Gotify-Key authentication description and points to the webhook examples directory for Microsoft Teams.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 0d44b

This PR makes localized cleanup changes to webhook documentation and the Gotify example without changing product runtime behavior. No actionable merge-blocking risk remains beyond normal checks and review.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the documentation cleanup in the webhook examples.
Description check ✅ Passed The description explains the cleanup, includes relevant before-and-after context, completes the applicable checklist items, and states that there are no user-facing changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (3 skipped: 3 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with 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.

❤️ Share

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

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.

1 participant