Skip to content

docs(help): add alert notification overview page - #4300

Merged
lynx009 merged 9 commits into
apache:masterfrom
paultanay:docs-alert-notification-overview
Aug 8, 2026
Merged

docs(help): add alert notification overview page#4300
lynx009 merged 9 commits into
apache:masterfrom
paultanay:docs-alert-notification-overview

Conversation

@paultanay

@paultanay paultanay commented Aug 2, 2026

Copy link
Copy Markdown
Contributor

What this PR does

Fix broken links in the Alarm Notification section of help/guide.md.
Discord, Slack, and Telegram were pointing to alert_webhook instead
of their own dedicated pages. Also adds the missing SMS, Enterprise
WeChat App, FeiShu App, and Notification Template links that were
absent from the section.

Checklist

  • Documentation updated

Part of #3166

- Add alert_notification_overview.md (EN and ZH-CN) as an overview page
  for the notification channel section, linking all supported channels
- Fix broken links in guide.md: Discord, Slack, Telegram were pointing
  to alert_webhook instead of their dedicated pages
- Add missing channels in guide.md: SMS, Enterprise WeChat App,
  FeiShu App, Notification Template
- Register alert_notification_overview as first entry in the
  'notice' sidebar category

Closes apache#3166
@github-actions github-actions Bot added the doc Improvements or additions to documentation label Aug 2, 2026
@lynx009
lynx009 marked this pull request as ready for review August 3, 2026 04:39
@paultanay

Copy link
Copy Markdown
Contributor Author

@tomsun28 @lynx009 CI seems to have only run the license header check, Could you take a look when you have a moment... Thanks!

@lynx009

lynx009 commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Alert'notication_overview.md feels a bit redundant because we already have it in our guide for getting started, so we can just keep guide.md.
截屏2026-08-07 23 08 19

Discord, Slack and Telegram links in the Alarm notification section
were pointing to alert_webhook instead of their own pages. This also
adds the missing SMS, Enterprise WeChat App, FeiShu App and
Notification Template links to the section.

Resolves the broken links reported under apache#3166.
@paultanay

Copy link
Copy Markdown
Contributor Author

Alert'notication_overview.md feels a bit redundant because we already have it in our guide for getting started, so we can just keep guide.md. 截屏2026-08-07 23 08 19

addressed the review

The links pointed to github.com/hertzbeat/hertzbeat (old repo, now 404)
instead of the current Apache repo. Updated to raw.githubusercontent.com/apache/hertzbeat.
@lynx009
lynx009 merged commit c4b4e85 into apache:master Aug 8, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants