docs: add reusable HTML email template example#5391
Conversation
Signed-off-by: Dean Chen <51218137+locker95@users.noreply.github.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughAdds documentation showing how to define a reusable HTML email template in an external file, load it through Alertmanager configuration, and reference it from an email receiver. ChangesEmail template documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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.
🧹 Nitpick comments (1)
docs/notification_examples.md (1)
111-111: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winAdd language identifiers to the fenced code blocks.
Use
htmlfor the template block andyamlfor the Alertmanager configuration block to resolve the reported MD040 warnings.Also applies to: 140-140
🤖 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/notification_examples.md` at line 111, Update the fenced code blocks in the notification examples, including the template block and Alertmanager configuration block, with the language identifiers html and yaml respectively to resolve MD040 warnings.Source: Linters/SAST tools
🤖 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.
Nitpick comments:
In `@docs/notification_examples.md`:
- Line 111: Update the fenced code blocks in the notification examples,
including the template block and Alertmanager configuration block, with the
language identifiers html and yaml respectively to resolve MD040 warnings.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 86705770-9d2c-4c6d-8f0c-fbb2daef4752
📒 Files selected for processing (1)
docs/notification_examples.md
Signed-off-by: Dean Chen <51218137+locker95@users.noreply.github.com>
Summary
Add a complete example showing how to define an external HTML email template, load it with the top-level
templatesglob, and reference it from an email receiver. The example stays intentionally small while covering the configuration gap described in #1602.cc @mxinden
Pull Request Checklist
Validation
git diff --checktoUpperfunction against the current template data model and function mapThis is a documentation-only change; no product code tests were run.
Which user-facing changes does this PR introduce?