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] Write help documents #1795

Open
19 of 38 tasks
TJxiaobao opened this issue Apr 20, 2024 · 21 comments
Open
19 of 38 tasks

[Task] Write help documents #1795

TJxiaobao opened this issue Apr 20, 2024 · 21 comments
Labels
doc Improvements or additions to documentation good first pull request Good for newcomers status: volunteer wanted

Comments

@TJxiaobao
Copy link
Contributor

TJxiaobao commented Apr 20, 2024

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

  • almalinux
  • api_code
  • app-cisco_switch
  • app-clickhouse
  • app-coreos
  • app-debian #1835
  • app-dns
  • app-doris_fe
  • app-elasticsearch
  • app-emqx
  • app-euleros
  • app-flink
  • app-freebsd
  • app-ftp
  • app-h3c_switch
  • app-hertzbeat
  • app-hertzbeat_token
  • app-hpe_switch
  • app-huawei_switch
  • app-influxdb_promql
  • app-kafka_promql
  • app-mongodb
  • app-nacos
  • app-nebulaGraph
  • app-opensuse
  • app-prometheus
  • app-push
  • app-redhat
  • app-redis_cluster
  • app-redis_sentinel
  • app-rocketmq
  • app-rockylinux
  • app-springboot3
  • app-storm
  • app-tidb
  • app-tplink_switch
  • app-udp_port
  • app-websocket
@TJxiaobao TJxiaobao added doc Improvements or additions to documentation good first pull request Good for newcomers status: volunteer wanted labels Apr 20, 2024
@LiuTianyou
Copy link
Contributor

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

@TJxiaobao
Copy link
Contributor Author

Thank you for your contribution.

@zqr10159 zqr10159 changed the title [Task] <title> Write help documents [Task] Write help documents Apr 20, 2024
@LiuTianyou
Copy link
Contributor

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

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

@TJxiaobao
Copy link
Contributor Author

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

Thank you for your contribution.

@zuobiao-zhou
Copy link
Contributor

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

@Alanxtl
Copy link
Contributor

Alanxtl commented Apr 24, 2024

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

@TJxiaobao
Copy link
Contributor Author

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

Well, thank you for your contribution.

@TJxiaobao
Copy link
Contributor Author

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

Alanxtl commented Apr 24, 2024

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

@zhangshenghang
Copy link
Contributor

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

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

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

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

@TJxiaobao
Copy link
Contributor Author

debian

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

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

@TJxiaobao
Copy link
Contributor Author

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

this issue :#1835

@HeartLinked
Copy link
Contributor

HeartLinked commented Apr 29, 2024

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

@TJxiaobao
Copy link
Contributor Author

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

Hi,Almalinux can be assigned to me

@TJxiaobao
Copy link
Contributor Author

Hi,Almalinux can be assigned to me

👍👍👍

@Thespica
Copy link
Contributor

Thespica commented May 16, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation good first pull request Good for newcomers status: volunteer wanted
Projects
Development

No branches or pull requests

7 participants