apache / hertzbeat

Apache HertzBeat(incubating) is a real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities.
https://hertzbeat.apache.org/
Apache License 2.0
5.46k stars 950 forks source link

[Task] Write help documents #1795

Open TJxiaobao opened 5 months ago

TJxiaobao commented 5 months ago

Description

We have some help documents for monitoring templates that have not been written, and now we need some volunteers to write the documents. May refer to: 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/tree/master/manager/src/main/resources/define home/sidebars.json

Note: One copy of the help document is required in English and one in Chinese

Task List

LiuTianyou commented 5 months ago

Hello, let me write the help documentation for clickhouse monitoring.

TJxiaobao commented 5 months ago

Thank you for your contribution.

LiuTianyou commented 5 months ago

Hello, I am already familiar with how to add documents. Next, let me add help documents for DNS, elasticsearch, ftp, mongodb, websocket, and prometheus monitoring.

zhangshenghang commented 4 months ago

Hello, do doris_fe monitoring documents need to be written? I can complete it.

TJxiaobao commented 4 months ago

Hello, do doris_fe monitoring documents need to be written? I can complete it.

Thank you for your contribution.

zuobiao-zhou commented 4 months ago

Please assign app-springboot3 and app-udp_port to me.

Alanxtl commented 4 months ago

Hi, I have completed written docs for Huawei Monitoring, Nacos and Tidb.

TJxiaobao commented 4 months ago

Please assign app-springboot3 and app-udp_port to me.

Well, thank you for your contribution.

TJxiaobao commented 4 months ago

Hi, I have completed written docs for Huawei Monitoring, Cacos and Tidb.

If you have finished please mention a pr merge into the master branch, thank you for your contribution.

Alanxtl commented 4 months ago

Hi, I have completed written docs for Huawei Monitoring, Nacos and Tidb.

If you have finished please mention a pr merge into the master branch, thank you for your contribution.

They have been merged https://github.com/apache/hertzbeat/pull/1823 and https://github.com/apache/hertzbeat/pull/1813

zhangshenghang commented 4 months ago

Hello, do doris_fe monitoring documents need to be written? I can complete it.

Thank you for your contribution.

Hi,Doris FE Chinese and English documentation has been added, and I have submitted a PR.

TJxiaobao commented 4 months ago

Hi, I have completed written docs for Huawei Monitoring, Nacos and Tidb.

If you have finished please mention a pr merge into the master branch, thank you for your contribution.

They have been merged #1823 and #1813

πŸ‘πŸ‘πŸ‘

TJxiaobao commented 4 months ago

Hello, do doris_fe monitoring documents need to be written? I can complete it.

Thank you for your contribution.

Hi,Doris FE Chinese and English documentation has been added, and I have submitted a PR.

πŸ‘πŸ‘πŸ‘

zhangshenghang commented 4 months ago

Hi, is the debian system monitoring file completed? i can finish it

TJxiaobao commented 4 months ago

debian

Hi, is the debian system monitoring file completed? i can finish it

Not at the moment, you can try to finish it.

TJxiaobao commented 4 months ago

Hi, is the debian system monitoring file completed? i can finish it

this issue :https://github.com/apache/hertzbeat/issues/1835

HeartLinked commented 4 months ago

I can try to complete documents for flink. Please assign them to me.

TJxiaobao commented 4 months ago

I can try to complete documents for flink. Please assign them to me.

Well, you can try to finish it and launch a pr.

zhangshenghang commented 4 months ago

Hi,Almalinux can be assigned to me

TJxiaobao commented 4 months ago

Hi,Almalinux can be assigned to me

πŸ‘πŸ‘πŸ‘

Thespica commented 4 months ago

Hi, @TJxiaobao , I noticed that this part of doc is under zh-cn but written in en.

I can translate it to Chinese if this work is needed.

zzzk1 commented 3 months ago

pls assigne app-redis_cluster to me ~