[Task] <Help Doc For Some HertzBeat Functions>

[tomsun28]

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:nightly

docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat:nightly

Task List

• [ ] Some missing in new monitoring types
• [ ] Alerting Threshold - RealTime Threshold
• [ ] Alerting Threshold - Periodic Threshold @MasamiYui
• [x] Alerting Integration @bigcyy
• [x] Alerting Group @LiuTianyou
• [x] Alerting Inhibit @LiuTianyou
• [x] Alerting Silence @a-little-fool
• [x] Alerting Alarms Center @bigcyy
• [ ] Some missing in Alerting Notification
• [ ] Status Page
• [x] Collector @sarthakeash

[sarthakeash]

Happy to contribute in this. Can start with Collector.

[bigcyy]

I can help supplement the documentation for the Alerting Alarms Center section.

[tomsun28]

welcome!

[PengJingzhao]

我可以帮助完成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?

[tomsun28]

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

[MasamiYui]

Suggest update the UserGuide of the function together. There are some incorrect links or 404.e.g:

[LiuTianyou]

hi, has anyone started to add help documents for alerting group and inhibit? If not, please assign it to me and I will try to add these documents

[tomsun28]

not yet, welcome!

[lynx009]

Hello, I want to help complete the alerting silence documents.

[MasamiYui]

Hi, I want to help complete the alerting Threshold - Periodic Threshold.

[bigcyy]

hi, I can help supplement the documentation for the Alerting Integration