hertzbeat icon indicating copy to clipboard operation
hertzbeat copied to clipboard

[Task] Write help documents

Open TJxiaobao opened this issue 1 year ago β€’ 22 comments

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

  • [x] almalinux
  • [x] api_code
  • [ ] app-cisco_switch
  • [x] app-clickhouse
  • [x] app-coreos
  • [x] #1835
  • [x] app-dns
  • [x] app-doris_fe
  • [ ] app-elasticsearch
  • [ ] app-emqx
  • [ ] app-euleros
  • [x] app-flink
  • [x] app-freebsd
  • [x] app-ftp
  • [ ] app-h3c_switch
  • [ ] app-hertzbeat
  • [ ] app-hertzbeat_token
  • [ ] app-hpe_switch
  • [x] app-huawei_switch
  • [ ] app-influxdb_promql
  • [ ] app-kafka_promql
  • [x] app-mongodb
  • [ ] app-nacos
  • [ ] app-nebulaGraph
  • [x] app-opensuse
  • [x] app-prometheus
  • [ ] app-push
  • [ ] app-redhat
  • [ ] app-redis_cluster
  • [ ] app-redis_sentinel
  • [x] app-rocketmq
  • [ ] app-rockylinux
  • [x] app-springboot3
  • [ ] app-storm
  • [x] app-tidb
  • [ ] app-tplink_switch
  • [x] app-udp_port
  • [x] app-websocket

TJxiaobao avatar Apr 20 '24 03:04 TJxiaobao

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

LiuTianyou avatar Apr 20 '24 03:04 LiuTianyou

Thank you for your contribution.

TJxiaobao avatar Apr 20 '24 04:04 TJxiaobao

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.

LiuTianyou avatar Apr 21 '24 01:04 LiuTianyou

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

zhangshenghang avatar Apr 23 '24 11:04 zhangshenghang

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

Thank you for your contribution.

TJxiaobao avatar Apr 23 '24 11:04 TJxiaobao

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

zuobiao-zhou avatar Apr 24 '24 02:04 zuobiao-zhou

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

Alanxtl avatar Apr 24 '24 02:04 Alanxtl

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

Well, thank you for your contribution.

TJxiaobao avatar Apr 24 '24 03:04 TJxiaobao

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.

TJxiaobao avatar Apr 24 '24 03:04 TJxiaobao

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

Alanxtl avatar Apr 24 '24 03:04 Alanxtl

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 avatar Apr 24 '24 04:04 zhangshenghang

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 avatar Apr 24 '24 04:04 TJxiaobao

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 avatar Apr 24 '24 04:04 TJxiaobao

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

zhangshenghang avatar Apr 24 '24 13:04 zhangshenghang

debian

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

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

TJxiaobao avatar Apr 24 '24 13:04 TJxiaobao

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

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

TJxiaobao avatar Apr 24 '24 13:04 TJxiaobao

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

HeartLinked avatar Apr 29 '24 06:04 HeartLinked

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

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

TJxiaobao avatar Apr 29 '24 08:04 TJxiaobao

Hi,Almalinux can be assigned to me

zhangshenghang avatar Apr 30 '24 06:04 zhangshenghang

Hi,Almalinux can be assigned to me

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

TJxiaobao avatar Apr 30 '24 12:04 TJxiaobao

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.

Thespica avatar May 16 '24 02:05 Thespica

pls assigne app-redis_cluster to me ~

zhengkezhou1 avatar Jun 07 '24 10:06 zhengkezhou1