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.45k stars 946 forks source link

[Task] Optimize historical Markdown file format #2574

Open zhangshenghang opened 3 weeks ago

zhangshenghang commented 3 weeks ago

Description

We have changed the Markdown formatting tool to Markdownlint, which can set rules more comprehensively. At the same time, some new tasks have been added. Setting rules will cause a lot of history files to be modified.

It is divided into the following tasks. If you are interested, you can claim them yourself.

image

rule description : https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md

task assignee complete status
MD001 @tomsun28
MD003 @Calvin979
MD013 @tomsun28
MD024 @zhangshenghang
MD025 @Aias00
MD029 @pwallk
MD033 @Calvin979
MD035 @zhangshenghang
MD036 @yuluo-yx
MD040 @yuluo-yx
MD041 @zhangshenghang
MD045 @Calvin979
MD046 @zhangshenghang
MD047 @LiuTianyou
MD052 @zhangshenghang

Task List

No response

tomsun28 commented 3 weeks ago

please assign MD001 to me thanks.

zhangshenghang commented 3 weeks ago

please assign MD001 to me thanks.

Assigned

Calvin979 commented 3 weeks ago

I claim MD003

zhangshenghang commented 3 weeks ago

I claim MD003

@Calvin979 Assigned, task needs to wait for #2572 to be merged before proceeding

pwallk commented 3 weeks ago

please assign MD029 to me thanks.

LiuTianyou commented 3 weeks ago

please assign MD047 to me thanks

zhangshenghang commented 3 weeks ago

Assigned

Assigned , thks

zhangshenghang commented 3 weeks ago

please assign MD047 to me thanks

@LiuTianyou Assigned , thks

tomsun28 commented 3 weeks ago

hi all, please use the latest master home code to work it.

tomsun28 commented 3 weeks ago

see https://github.com/DavidAnson/markdownlint-cli2 to know how to check in local

Aias00 commented 3 weeks ago

pls assign MD025 to me

yuluo-yx commented 2 weeks ago

36 40, I solved it

tomsun28 commented 2 weeks ago

pls assign MD013 to me

Calvin979 commented 1 week ago

pls assign MD033 and MD045 to me