[Task] <Help Doc For Some HertzBeat Functions>
- Dominant language
- Java
- Stars
- 7.4k
- Forks
- 1.3k
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 32
Description
### 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
Contributor guide
Research direction
Start with the unchecked items in the issue and compare the existing pages under home/docs/help and home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help, using home/sidebars.json around line 71 to understand navigation. Run apache/hertzbeat:nightly with the supplied Docker command when a feature needs the latest version. Done means the selected missing help pages are documented and linked in the appropriate documentation structure.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker
- Domain
- documentation, observability
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100