[improve]improve doc 052 (apache#2654)

zhangshenghang · web-flow · commit 714f2164702b · 2024-09-02T21:55:42.000+08:00
diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc
@@ -35,7 +35,7 @@
     "MD045": false,
     "MD046": true,
     "MD047": true,
-    "MD052": false
+    "MD052": true
   },
   "ignore": [
     "node_modules/",
diff --git a/hip/README.md b/hip/README.md
@@ -64,7 +64,7 @@ The process works in the following way:
 2. Clone the repository, and on it, copy the file `hip/TEMPLATE.md` and name it `hip-xxx.md`. The number `xxx` should be the next sequential number after the last contributed HIP. You view the list of contributed HIPs (at any status) as a list of Pull Requests having a "HIP" label. Use the link [here](https://github.com/apache/hertzbeat/pulls?q=is%3Apr+label%3Ahip+) as shortcut.
 3. Write the proposal following the section outlined by the template and the explanation for each section in the comment it contains (you can delete the comment once done).
     * If you need diagrams, avoid attaching large files. You can use [MermaidJS](https://mermaid.js.org/) as simple language to describe many types of diagrams.
-4. Create GitHub Pull request (PR). The PR title should be `[improve][hip] HIP-xxx: {title}`, where the `xxx` match the number given in previous step (file-name). Replace `{title}` with a short title to your proposal.
+4. Create GitHub Pull request (PR). The PR title should be `[improve]\[HIP\] HIP-xxx: {title}`, where the `xxx` match the number given in previous step (file-name). Replace `{title}` with a short title to your proposal.
    *Validate* again that your number does not collide, by step (2) numbering check.
 5. The author(s) will email the dev@hertzbeat.apache.org mailing list to kick off a discussion, using subject prefix `[DISCUSS] HIP-xxx: {HIP TITLE}`. The discussion will happen in broader context either on the mailing list or as general comments on the PR. Many of the discussion items will be on particular aspect of the proposal, hence they should be as comments in the PR to specific lines in the proposal file.
 6. Update file with a link to the discussion on the mailing. You can obtain it from [Apache Pony Mail](https://lists.apache.org/list.html?dev@hertzbeat.apache.org).
@@ -86,7 +86,7 @@ It is advised to create a master GitHub issue to formulate the execution plan an
 ## List of HIPs
 
 ### List of HIPs
-1. You can view all HIPs as the list of Pull Requests having title starting with `[improve][HIP] HIP-`. Here is the [link](https://github.com/apache/hertzbeat/pulls?q=is%3Apr+title%3A%22%5BHIP%5D%5Bdesign%5D+hip-%22) for it.
+1. You can view all HIPs as the list of Pull Requests having title starting with `[improve]\[HIP\] HIP-`. Here is the [link](https://github.com/apache/hertzbeat/pulls?q=is%3Apr+title%3A%22%5BHIP%5D%5Bdesign%5D+hip-%22) for it.
     - Merged PR means the HIP was accepted.
     - Closed PR means the HIP was rejected.
     - Open PR means the HIP was submitted and is in the process of discussion.
diff --git a/home/blog/2022-11-28-hertzbeat-v1.2.2.md b/home/blog/2022-11-28-hertzbeat-v1.2.2.md
@@ -29,9 +29,9 @@ Feature：
 4. [[collector] support trigger and grading multiple subtasks through -_- placeholder expression #418](https://github.com/apache/hertzbeat/pull/418)
 5. [WIP:feature support k8s monitor, http monitor nacos, service&http_micro monitor msa #421](https://github.com/apache/hertzbeat/pull/421) @cuipiheqiuqiu
 6. [[manager] support opengauss database monitor #422](https://github.com/apache/hertzbeat/pull/422)
-7. [[#406][warehose] Add unit test MetricsDataControllerTest.java #426](https://github.com/apache/hertzbeat/pull/426) @haibo-duan
-8. [[#358][manager] Add unit test manager/service/NoticeConfigServiceTest.java #427](https://github.com/apache/hertzbeat/pull/427) @haibo-duan
-9. [[#356][manager] unit test case of manager/service/MailServiceTest.java #432](https://github.com/apache/hertzbeat/pull/432) @csyshu
+7. [[#406]\[warehose\] Add unit test MetricsDataControllerTest.java #426](https://github.com/apache/hertzbeat/pull/426) @haibo-duan
+8. [[#358]\[manager\] Add unit test manager/service/NoticeConfigServiceTest.java #427](https://github.com/apache/hertzbeat/pull/427) @haibo-duan
+9. [[#356]\[manager\] unit test case of manager/service/MailServiceTest.java #432](https://github.com/apache/hertzbeat/pull/432) @csyshu
 10. [[manager,collector] support docker metrics monitor #438](https://github.com/apache/hertzbeat/pull/438) @TJxiaobao
 11. [[alerter] implement AlertDefineControllerTest unit case #448](https://github.com/apache/hertzbeat/pull/448) @Ceilzcx
 12. [[collector] support spi load AbstractCollect Impl instance #449](https://github.com/apache/hertzbeat/pull/449)
@@ -78,9 +78,9 @@ Feature：
 4. [[collector] support trigger and grading multiple subtasks through -_- placeholder expression #418](https://github.com/apache/hertzbeat/pull/418)
 5. [WIP:feature support k8s monitor, http monitor nacos, service&http_micro monitor msa #421](https://github.com/apache/hertzbeat/pull/421) @cuipiheqiuqiu
 6. [[manager] support opengauss database monitor #422](https://github.com/apache/hertzbeat/pull/422)
-7. [[#406][warehose] Add unit test MetricsDataControllerTest.java #426](https://github.com/apache/hertzbeat/pull/426) @haibo-duan
-8. [[#358][manager] Add unit test manager/service/NoticeConfigServiceTest.java #427](https://github.com/apache/hertzbeat/pull/427) @haibo-duan
-9. [[#356][manager] unit test case of manager/service/MailServiceTest.java #432](https://github.com/apache/hertzbeat/pull/432) @csyshu
+7. [[#406]\[warehose\] Add unit test MetricsDataControllerTest.java #426](https://github.com/apache/hertzbeat/pull/426) @haibo-duan
+8. [[#358]\[manager\] Add unit test manager/service/NoticeConfigServiceTest.java #427](https://github.com/apache/hertzbeat/pull/427) @haibo-duan
+9. [[#356]\[manager\] unit test case of manager/service/MailServiceTest.java #432](https://github.com/apache/hertzbeat/pull/432) @csyshu
 10. [[manager,collector] support docker metrics monitor #438](https://github.com/apache/hertzbeat/pull/438) @TJxiaobao
 11. [[alerter] implement AlertDefineControllerTest unit case #448](https://github.com/apache/hertzbeat/pull/448) @Ceilzcx
 12. [[collector] support spi load AbstractCollect Impl instance #449](https://github.com/apache/hertzbeat/pull/449)
diff --git a/home/blog/2024-06-15-hertzbeat-v1.6.0.md b/home/blog/2024-06-15-hertzbeat-v1.6.0.md
@@ -50,7 +50,7 @@ Upgrade Guide: <https://hertzbeat.apache.org/blog/2024/06/11/hertzbeat-v1.6.0-up
 * add dependency license doc
 * [feature]Hertzbeat custom plugin. by @zqr10159 in #1973
 * [feature] add apache hugegraph monitor by @zhangshenghang in #1972
-* [improve][HIP] HIP-01: Implement refactoring AbstractCollect by @crossoverJie in #1966
+* [improve]\[HIP\] HIP-01: Implement refactoring AbstractCollect by @crossoverJie in #1966
 * [feature] Support monitoring of OpenAI accounts by @zuobiao-zhou in #1947
 * [feature] add apache yarn monitor by @zhangshenghang in #1937
 * [featrue]add apache hdfs monitor by @zhangshenghang in #1920
@@ -172,7 +172,7 @@ Upgrade Guide: <https://hertzbeat.apache.org/blog/2024/06/11/hertzbeat-v1.6.0-up
 * [doc] Add help document for elasticsearch monitoring and ftp monitoring by @LiuTianyou in <https://github.com/apache/hertzbeat/pull/1815>
 * [doc] add help documentation for huawei switch monitoring  by @Alanxtl in <https://github.com/apache/hertzbeat/pull/1813>
 * chore: upgrade the api-testing (e2e) to v0.0.16 by @LinuxSuRen in <https://github.com/apache/hertzbeat/pull/1817>
-* [Remove][Improve]Mail config by @zqr10159 in <https://github.com/apache/hertzbeat/pull/1819>
+* [Remove]\[Improve\]Mail config by @zqr10159 in <https://github.com/apache/hertzbeat/pull/1819>
 * Remove and translate chinese to english in code by @dukbong in <https://github.com/apache/hertzbeat/pull/1816>
 * [feature]Add monitoring for Hbase Master by @zhangshenghang in <https://github.com/apache/hertzbeat/pull/1820>
 * [doc] resolve code conflicts and coverage caused by pr(#1813) merge by @LiuTianyou in <https://github.com/apache/hertzbeat/pull/1821>
@@ -217,7 +217,7 @@ Upgrade Guide: <https://hertzbeat.apache.org/blog/2024/06/11/hertzbeat-v1.6.0-up
 * [feature] support the VictoriaMetrics cluster by @xuziyang in <https://github.com/apache/hertzbeat/pull/1880>
 * [improve] Refactor common cache code by @crossoverJie in <https://github.com/apache/hertzbeat/pull/1881>
 * Eliminate Unnecessary Unboxing and Generics by @handy-git in <https://github.com/apache/hertzbeat/pull/1882>
-* [bugfix][doc]Add kafka sidebar. by @zqr10159 in <https://github.com/apache/hertzbeat/pull/1883>
+* [bugfix]\[doc\]Add kafka sidebar. by @zqr10159 in <https://github.com/apache/hertzbeat/pull/1883>
 * [doc] I18n for monitoring template yml metrics  by @zuobiao-zhou in <https://github.com/apache/hertzbeat/pull/1888>
 * [refactor] StoreProperties is no longer useful, delete it by @xuziyang in <https://github.com/apache/hertzbeat/pull/1887>
 * bugfix statistical metrics data matching fails by @tomsun28 in <https://github.com/apache/hertzbeat/pull/1884>
@@ -268,17 +268,17 @@ Upgrade Guide: <https://hertzbeat.apache.org/blog/2024/06/11/hertzbeat-v1.6.0-up
 * [test] add test for NgqlCollectImpl by @LiuTianyou in <https://github.com/apache/hertzbeat/pull/1953>
 * [bugfix]Replace monitors to alert. by @zqr10159 in <https://github.com/apache/hertzbeat/pull/1954>
 * [improve] add llm, server menu and update doc by @tomsun28 in <https://github.com/apache/hertzbeat/pull/1955>
-* [improve][HIP] HIP-01: Refactoring AbstractCollect by @crossoverJie in <https://github.com/apache/hertzbeat/pull/1930>
+* [improve]\[HIP\] HIP-01: Refactoring AbstractCollect by @crossoverJie in <https://github.com/apache/hertzbeat/pull/1930>
 * [bugfix] fix ConnectionCommonCache possible npe by @crossoverJie in <https://github.com/apache/hertzbeat/pull/1959>
 * [doc] add help document for eulerOS monitoring by @LiuTianyou in <https://github.com/apache/hertzbeat/pull/1960>
 * [fixbug] Fix the problem of no data for springboot3 monitoring by @zhangshenghang in <https://github.com/apache/hertzbeat/pull/1961>
 * commit：fix the front-end popup cannot exit by @Yanshuming1 in <https://github.com/apache/hertzbeat/pull/1957>
 * [fixbug] expression rule adaptation by @zhangshenghang in <https://github.com/apache/hertzbeat/pull/1963>
 * [doc] add  help doc for influxdb-promql and kafka-promql monitoring by @LiuTianyou in <https://github.com/apache/hertzbeat/pull/1965>
 * [doc]: update readme-cn docs by @yuluo-yx in <https://github.com/apache/hertzbeat/pull/1964>
-* [improve][HIP] HIP-01: Implement refactoring AbstractCollect by @crossoverJie in <https://github.com/apache/hertzbeat/pull/1966>
+* [improve]\[HIP\] HIP-01: Implement refactoring AbstractCollect by @crossoverJie in <https://github.com/apache/hertzbeat/pull/1966>
 * [chore] update .gitignore to save .idea/icon.png by @yuluo-yx in <https://github.com/apache/hertzbeat/pull/1971>
-* [improve][bugfix]: fix AlertTemplateUtilTest test exception and update code style by @yuluo-yx in <https://github.com/apache/hertzbeat/pull/1969>
+* [improve]\[bugfix\]: fix AlertTemplateUtilTest test exception and update code style by @yuluo-yx in <https://github.com/apache/hertzbeat/pull/1969>
 * [feature] add apache hugegraph monitor by @zhangshenghang in <https://github.com/apache/hertzbeat/pull/1972>
 * [improve] Implement cascading parameter list for SNMP protocol by @zuobiao-zhou in <https://github.com/apache/hertzbeat/pull/1976>
 * [improve] optimize DateUtil and add test case by @yuluo-yx in <https://github.com/apache/hertzbeat/pull/1974>
diff --git a/home/docs/community/how-to-release.md b/home/docs/community/how-to-release.md
@@ -400,7 +400,7 @@ Thanks!
 After 72 hours, the voting results will be counted, and the voting result email will be sent, as follows.
 
 > `Send to`: <dev@hertzbeat.apache.org> <br />
-> `Title`: [RESULT][VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1 <br />
+> `Title`: [RESULT]\[VOTE\] Release Apache HertzBeat (incubating) 1.6.0-rc1 <br />
 > `Body`:
 
 ```text
@@ -502,7 +502,7 @@ Chunjin Mu
 Then the voting results will be counted, and the voting result email will be sent, as follows.
 
 > `Send to`: <general@incubator.apache.org> <br />
-> `Title`: [RESULT][VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1 <br />
+> `Title`: [RESULT]\[VOTE\] Release Apache HertzBeat (incubating) 1.6.0-rc1 <br />
 > `Body`:
 
 ```text
diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-11-28-hertzbeat-v1.2.2.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-11-28-hertzbeat-v1.2.2.md
@@ -29,9 +29,9 @@ Feature：
 4. [[collector] support trigger and grading multiple subtasks through -_- placeholder expression #418](https://github.com/apache/hertzbeat/pull/418)
 5. [WIP:feature support k8s monitor, http monitor nacos, service&http_micro monitor msa #421](https://github.com/apache/hertzbeat/pull/421) @cuipiheqiuqiu
 6. [[manager] support opengauss database monitor #422](https://github.com/apache/hertzbeat/pull/422)
-7. [[#406][warehose] Add unit test MetricsDataControllerTest.java #426](https://github.com/apache/hertzbeat/pull/426) @haibo-duan
-8. [[#358][manager] Add unit test manager/service/NoticeConfigServiceTest.java #427](https://github.com/apache/hertzbeat/pull/427) @haibo-duan
-9. [[#356][manager] unit test case of manager/service/MailServiceTest.java #432](https://github.com/apache/hertzbeat/pull/432) @csyshu
+7. [[#406]\[warehose\] Add unit test MetricsDataControllerTest.java #426](https://github.com/apache/hertzbeat/pull/426) @haibo-duan
+8. [[#358]\[manager\] Add unit test manager/service/NoticeConfigServiceTest.java #427](https://github.com/apache/hertzbeat/pull/427) @haibo-duan
+9. [[#356]\[manager\] unit test case of manager/service/MailServiceTest.java #432](https://github.com/apache/hertzbeat/pull/432) @csyshu
 10. [[manager,collector] support docker metrics monitor #438](https://github.com/apache/hertzbeat/pull/438) @TJxiaobao
 11. [[alerter] implement AlertDefineControllerTest unit case #448](https://github.com/apache/hertzbeat/pull/448) @Ceilzcx
 12. [[collector] support spi load AbstractCollect Impl instance #449](https://github.com/apache/hertzbeat/pull/449)
@@ -78,9 +78,9 @@ Feature：
 4. [[collector] support trigger and grading multiple subtasks through -_- placeholder expression #418](https://github.com/apache/hertzbeat/pull/418)
 5. [WIP:feature support k8s monitor, http monitor nacos, service&http_micro monitor msa #421](https://github.com/apache/hertzbeat/pull/421) @cuipiheqiuqiu
 6. [[manager] support opengauss database monitor #422](https://github.com/apache/hertzbeat/pull/422)
-7. [[#406][warehose] Add unit test MetricsDataControllerTest.java #426](https://github.com/apache/hertzbeat/pull/426) @haibo-duan
-8. [[#358][manager] Add unit test manager/service/NoticeConfigServiceTest.java #427](https://github.com/apache/hertzbeat/pull/427) @haibo-duan
-9. [[#356][manager] unit test case of manager/service/MailServiceTest.java #432](https://github.com/apache/hertzbeat/pull/432) @csyshu
+7. [[#406]\[warehose\] Add unit test MetricsDataControllerTest.java #426](https://github.com/apache/hertzbeat/pull/426) @haibo-duan
+8. [[#358]\[manager\] Add unit test manager/service/NoticeConfigServiceTest.java #427](https://github.com/apache/hertzbeat/pull/427) @haibo-duan
+9. [[#356]\[manager\] unit test case of manager/service/MailServiceTest.java #432](https://github.com/apache/hertzbeat/pull/432) @csyshu
 10. [[manager,collector] support docker metrics monitor #438](https://github.com/apache/hertzbeat/pull/438) @TJxiaobao
 11. [[alerter] implement AlertDefineControllerTest unit case #448](https://github.com/apache/hertzbeat/pull/448) @Ceilzcx
 12. [[collector] support spi load AbstractCollect Impl instance #449](https://github.com/apache/hertzbeat/pull/449)
diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-06-15-hertzbeat-v1.6.0.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-06-15-hertzbeat-v1.6.0.md
@@ -50,7 +50,7 @@ keywords: [open source, monitoring, alerting]
 - add dependency license doc
 - [feature]Hertzbeat custom plugin. by @zqr10159 in #1973
 - [feature] add apache hugegraph monitor by @zhangshenghang in #1972
-- [improve][HIP] HIP-01: Implement refactoring AbstractCollect by @crossoverJie in #1966
+- [improve]\[HIP\] HIP-01: Implement refactoring AbstractCollect by @crossoverJie in #1966
 - [feature] Support monitoring of OpenAI accounts by @zuobiao-zhou in #1947
 - [feature] add apache yarn monitor by @zhangshenghang in #1937
 - [featrue]add apache hdfs monitor by @zhangshenghang in #1920
@@ -172,7 +172,7 @@ keywords: [open source, monitoring, alerting]
 - [doc] Add help document for elasticsearch monitoring and ftp monitoring by @LiuTianyou in <https://github.com/apache/hertzbeat/pull/1815>
 - [doc] add help documentation for huawei switch monitoring  by @Alanxtl in <https://github.com/apache/hertzbeat/pull/1813>
 - chore: upgrade the api-testing (e2e) to v0.0.16 by @LinuxSuRen in <https://github.com/apache/hertzbeat/pull/1817>
-- [Remove][Improve]Mail config by @zqr10159 in <https://github.com/apache/hertzbeat/pull/1819>
+- [Remove]\[Improve\]Mail config by @zqr10159 in <https://github.com/apache/hertzbeat/pull/1819>
 - Remove and translate chinese to english in code by @dukbong in <https://github.com/apache/hertzbeat/pull/1816>
 - [feature]Add monitoring for Hbase Master by @zhangshenghang in <https://github.com/apache/hertzbeat/pull/1820>
 - [doc] resolve code conflicts and coverage caused by pr(#1813) merge by @LiuTianyou in <https://github.com/apache/hertzbeat/pull/1821>
@@ -217,7 +217,7 @@ keywords: [open source, monitoring, alerting]
 - [feature] support the VictoriaMetrics cluster by @xuziyang in <https://github.com/apache/hertzbeat/pull/1880>
 - [improve] Refactor common cache code by @crossoverJie in <https://github.com/apache/hertzbeat/pull/1881>
 - Eliminate Unnecessary Unboxing and Generics by @handy-git in <https://github.com/apache/hertzbeat/pull/1882>
-- [bugfix][doc]Add kafka sidebar. by @zqr10159 in <https://github.com/apache/hertzbeat/pull/1883>
+- [bugfix]\[doc\]Add kafka sidebar. by @zqr10159 in <https://github.com/apache/hertzbeat/pull/1883>
 - [doc] I18n for monitoring template yml metrics  by @zuobiao-zhou in <https://github.com/apache/hertzbeat/pull/1888>
 - [refactor] StoreProperties is no longer useful, delete it by @xuziyang in <https://github.com/apache/hertzbeat/pull/1887>
 - bugfix statistical metrics data matching fails by @tomsun28 in <https://github.com/apache/hertzbeat/pull/1884>
@@ -268,17 +268,17 @@ keywords: [open source, monitoring, alerting]
 - [test] add test for NgqlCollectImpl by @LiuTianyou in <https://github.com/apache/hertzbeat/pull/1953>
 - [bugfix]Replace monitors to alert. by @zqr10159 in <https://github.com/apache/hertzbeat/pull/1954>
 - [improve] add llm, server menu and update doc by @tomsun28 in <https://github.com/apache/hertzbeat/pull/1955>
-- [improve][HIP] HIP-01: Refactoring AbstractCollect by @crossoverJie in <https://github.com/apache/hertzbeat/pull/1930>
+- [improve]\[HIP\] HIP-01: Refactoring AbstractCollect by @crossoverJie in <https://github.com/apache/hertzbeat/pull/1930>
 - [bugfix] fix ConnectionCommonCache possible npe by @crossoverJie in <https://github.com/apache/hertzbeat/pull/1959>
 - [doc] add help document for eulerOS monitoring by @LiuTianyou in <https://github.com/apache/hertzbeat/pull/1960>
 - [fixbug] Fix the problem of no data for springboot3 monitoring by @zhangshenghang in <https://github.com/apache/hertzbeat/pull/1961>
 - commit：fix the front-end popup cannot exit by @Yanshuming1 in <https://github.com/apache/hertzbeat/pull/1957>
 - [fixbug] expression rule adaptation by @zhangshenghang in <https://github.com/apache/hertzbeat/pull/1963>
 - [doc] add  help doc for influxdb-promql and kafka-promql monitoring by @LiuTianyou in <https://github.com/apache/hertzbeat/pull/1965>
 - [doc]: update readme-cn docs by @yuluo-yx in <https://github.com/apache/hertzbeat/pull/1964>
-- [improve][HIP] HIP-01: Implement refactoring AbstractCollect by @crossoverJie in <https://github.com/apache/hertzbeat/pull/1966>
+- [improve]\[HIP\] HIP-01: Implement refactoring AbstractCollect by @crossoverJie in <https://github.com/apache/hertzbeat/pull/1966>
 - [chore] update .gitignore to save .idea/icon.png by @yuluo-yx in <https://github.com/apache/hertzbeat/pull/1971>
-- [improve][bugfix]: fix AlertTemplateUtilTest test exception and update code style by @yuluo-yx in <https://github.com/apache/hertzbeat/pull/1969>
+- [improve]\[bugfix\]: fix AlertTemplateUtilTest test exception and update code style by @yuluo-yx in <https://github.com/apache/hertzbeat/pull/1969>
 - [feature] add apache hugegraph monitor by @zhangshenghang in <https://github.com/apache/hertzbeat/pull/1972>
 - [improve] Implement cascading parameter list for SNMP protocol by @zuobiao-zhou in <https://github.com/apache/hertzbeat/pull/1976>
 - [improve] optimize DateUtil and add test case by @yuluo-yx in <https://github.com/apache/hertzbeat/pull/1974>
diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/how-to-release.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/how-to-release.md
diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/how-to-release.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/how-to-release.md
diff --git a/home/versioned_docs/version-v1.5.x/community/how-to-release.md b/home/versioned_docs/version-v1.5.x/community/how-to-release.md
