apache / apache/hertzbeat

[Task] Write help documents

Open
#1,795 25 comments 0 reactions 0 assignees View on GitHub
doc good first pull request status: volunteer wanted
Dominant language
Java
Stars
7.4k
Forks
1.3k
Avg merge
1d 20h
Merged PRs (30d)
32

Description

### 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

Contributor guide

Open the contributing guide

Research direction

Start in home/docs/help and the matching Chinese directory under home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help; compare an unchecked template with completed documents. Check manager/src/main/resources/define and home/sidebars.json for the template details and navigation. Done means the selected help document exists in both English and Chinese and is included in the sidebar if needed.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, observability
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.