Repository navigation
[Task] <Help Doc For Some HertzBeat Functions> #3166
Description
Activity
- pinned this issue
on Mar 23, 2025 Happy to contribute in this. Can start with Collector.
I can help supplement the documentation for the Alerting Alarms Center section.
welcome!
Reacted by 彭镜肇我可以帮助完成Some missing in new monitoring types.
顺便问一下，是将这里的监控类型，补充到home/docs/inroduce.md中就可以了是吧I can help complete the task "Some missing in new monitoring types."
By the way, just to confirm, should the monitoring types here be added to home/docs/introduce.md?
I can help complete the task "Some missing in new monitoring types." By the way, just to confirm, should the monitoring types here be added to home/docs/introduce.md?
hi welcome, it is the each monitoring type help detail doc like this https://github.com/apache/hertzbeat/blob/master/home/docs/help/mysql.md
- added a commit that references this issue
on Mar 28, 2025 - linked a pull request that will close this issue[doc] add help documentation for Alarms Center #3181
on Mar 29, 2025 Suggest update the UserGuide of the function together. There are some incorrect links or 404.e.g:
Reacted by Tomsun283 remaining items
Hi, I want to help complete the alerting Threshold - Periodic Threshold.
Reacted by Tomsun28- linked a pull request that will close this issue[doc] update doc, usecase blog and help doc #3286
on Apr 22, 2025 hi, I can help supplement the documentation for the Alerting Integration
Reacted by Tomsun28Hi, I'd like to work on the Alerting Threshold - RealTime Threshold documentation. I have HertzBeat running locally and I'm already exploring the feature. Can I be assigned?
Reacted by Sherlock YinHi, I'd like to work on the Alerting Threshold - RealTime Threshold documentation. I have HertzBeat running locally and I'm already exploring the feature. Can I be assigned?
sure, welcome!
Hi, I'd like to work on - Some missing in Alerting Notification - adding a notification overview page alert_notification_overview.md that serves as a parent page linking all 14 notification channels, along with fixing the broken Discord, Slack, and Telegram links in guide.md that currently point to alert_webhook instead of their dedicated pages. Will keep the PR scoped to this.
- added a commit that references this issue
on Aug 7, 2026 I would like to document Status Page under #3166. I will add the EN help page, register the sidebar entry, and keep the walkthrough aligned with current UI.
Follow-up on my claim:
home/docs/help/status.md(Status Page) and the Real-time Threshold sections inalert_threshold.mdalready exist on master, so those two checklist items look complete. I will not open a duplicate docs PR for them. Happy to take a remaining gap such as a missing new monitoring type help page or an incomplete Alerting Notification page if a maintainer can point at a concrete file.
Description
Hi, we found that some of HertzBeat's features currently lack corresponding help documentation. Volunteers are welcome to contribute to supplement the help documentation.
Please feel free to pick that ❤️.
doc code here:
https://github.com/apache/hertzbeat/tree/master/home/docs/help
https://github.com/apache/hertzbeat/tree/master/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help
https://github.com/apache/hertzbeat/blob/master/home/sidebars.json#L71
some feature need latest version but have not publish, we can use the nightly docker images build everyday
apache/hertzbeat:nightlydocker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat:nightly
Task List