Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Task] <Help Doc For Some HertzBeat Functions> #3166

Open
11 tasks
tomsun28 opened this issue Mar 23, 2025 · 8 comments · Fixed by #3181
Open
11 tasks

[Task] <Help Doc For Some HertzBeat Functions> #3166

tomsun28 opened this issue Mar 23, 2025 · 8 comments · Fixed by #3181
Labels
discussion good first issue Good for newcomers help wanted Extra attention is needed

Comments

@tomsun28
Copy link
Contributor

tomsun28 commented Mar 23, 2025

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
  • Alerting Integration
  • Alerting Group @LiuTianyou
  • Alerting Inhibit @LiuTianyou
  • Alerting Silence
  • Alerting Alarms Center @bigcyy
  • Some missing in Alerting Notification
  • Status Page
  • Collector @sarthakeash
@sarthakeash
Copy link
Contributor

Happy to contribute in this. Can start with Collector.

@bigcyy
Copy link
Contributor

bigcyy commented Mar 23, 2025

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

@tomsun28
Copy link
Contributor Author

welcome!

@PengJingzhao
Copy link
Contributor

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

Image

Image

@tomsun28
Copy link
Contributor Author

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

tomsun28 added a commit to sarthakeash/hertzbeat that referenced this issue Mar 28, 2025
Signed-off-by: tomsun28 <tomsun28@outlook.com>
@tomsun28 tomsun28 linked a pull request Mar 29, 2025 that will close this issue
4 tasks
@MasamiYui
Copy link
Contributor

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

@LiuTianyou
Copy link
Contributor

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
Copy link
Contributor Author

tomsun28 commented Apr 1, 2025

not yet, welcome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion good first issue Good for newcomers help wanted Extra attention is needed
Projects
Development

Successfully merging a pull request may close this issue.

6 participants