[Improve] improve doc check (apache#2572)

Co-authored-by: YuLuo <[email protected]>
Co-authored-by: tomsun28 <[email protected]>
Co-authored-by: Calvin <[email protected]>

Author: 4 people

.github/workflows/doc-build-test.yml

@@ -34,6 +34,10 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
+      - name: Check Markdown
+        uses: DavidAnson/markdownlint-cli2-action@v16
+        with:
+          globs: './home/**/*.md'
       - name: Check filename in home/blog
         run: |
           TARGET_DIR="./home/blog"

.markdownlint-cli2.jsonc

@@ -0,0 +1,39 @@
+//
+// Licensed to the Apache Software Foundation (ASF) under one or more
+// contributor license agreements.  See the NOTICE file distributed with
+// this work for additional information regarding copyright ownership.
+// The ASF licenses this file to You under the Apache License, Version 2.0
+// (the "License"); you may not use this file except in compliance with
+// the License.  You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+{
+  "config": {
+    "default": true,
+    "MD001": false,
+    "MD052": false,
+    "MD003": false,
+    "MD013": false,
+    "MD024": false,
+    "MD025": false,
+    "MD029": false,
+    "MD033": false,
+    "MD035": false,
+    "MD036": false,
+    "MD040": false,
+    "MD041": false,
+    "MD045": false,
+    "MD046": false,
+    "MD047": false
+  },
+  "ignore": [
+    "node_modules/"
+  ]
+}

home/README.md

@@ -84,4 +84,3 @@ yarn docusaurus docs:version v1.5.x
 |-- docusaurus.config.js
 |-- sidebars.js // document sidebar menu configuration
 ```
-

home/blog/2022-06-01-hertzbeat-v1.0.md

@@ -52,11 +52,11 @@ Bug fix.
 5. [[collector]bugfix: fix warehouse data queue consume error #153](https://github.com/apache/hertzbeat/pull/153).  issue by @daqianxiaoyao
 6. [[web-app]bugfix:fix input blocking when input error in dark theme #157](https://github.com/apache/hertzbeat/pull/157). issue by @ConradWen
 
-**Full Changelog**: https://github.com/apache/hertzbeat/compare/v1.0-beta.8...v1.0
+**Full Changelog**: <https://github.com/apache/hertzbeat/compare/v1.0-beta.8...v1.0>
 
-Online https://console.tancloud.cn.
+Online <https://console.tancloud.cn>.
 
------------------------    
+-----------------------
 
 Redis monitor is coming：
 
@@ -77,6 +77,5 @@ Redis monitor is coming：
 
 **Repository url**
 
-[Github](https://github.com/apache/hertzbeat) https://github.com/apache/hertzbeat      
-[Gitee](https://gitee.com/hertzbeat/hertzbeat) https://gitee.com/hertzbeat/hertzbeat
-
+[Github](https://github.com/apache/hertzbeat) <https://github.com/apache/hertzbeat>
+[Gitee](https://gitee.com/hertzbeat/hertzbeat) <https://gitee.com/hertzbeat/hertzbeat>

home/blog/2022-06-19-hertzbeat-v1.1.0.md

@@ -33,7 +33,7 @@ Bugfixes:
 3. [[monitor] bugfix: Fix for Elasticsearch monitoring failure under basic authentication #174](https://github.com/apache/hertzbeat/pull/174) Contributed by @weifuqing
 4. [Fix for monitoring failure due to ambiguous Oracle monitoring parameter "database name" #182](https://github.com/apache/hertzbeat/pull/182) @zklmcookle
 
-Online at https://console.tancloud.cn.
+Online at <https://console.tancloud.cn>.
 
 ---
 Windows Monitor coming：
@@ -58,13 +58,13 @@ commit;
 
 Have Fun!
 
----- 
+----
 
 ## V1.1.0
 
 Home: hertzbeat.com | tancloud.cn
 
-Hi guys! HertzBeat v1.1.0 is coming. This version we support snmp protocol and use snmp to collect windows metrics.      
+Hi guys! HertzBeat v1.1.0 is coming. This version we support snmp protocol and use snmp to collect windows metrics.
 Another major change is that we use the H2 database by default to replace the MYSQL database as storage to facilitate the installation and deployment of users. Now only one docker command is needed to install and experience hertzbeat： `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat`
 Let's Try It!
 
@@ -86,7 +86,7 @@ Bugfix.
 3. [[monitor] bugfix: fix elasticsearch collect error when need basic auth #174](https://github.com/apache/hertzbeat/pull/174) contribute by @weifuqing
 4. [Change the Oracle database name to the service name to reduce ambiguity #182](https://github.com/apache/hertzbeat/pull/182) @zklmcookle
 
-Online https://console.tancloud.cn.
+Online <https://console.tancloud.cn>.
 
 ---
 
@@ -128,5 +128,5 @@ Have Fun!
 
 **Repository Addresses**
 
-[Github](https://github.com/apache/hertzbeat) https://github.com/apache/hertzbeat      
-[Gitee](https://gitee.com/hertzbeat/hertzbeat) https://gitee.com/hertzbeat/hertzbeat
+[Github](https://github.com/apache/hertzbeat) <https://github.com/apache/hertzbeat>
+[Gitee](https://gitee.com/hertzbeat/hertzbeat) <https://gitee.com/hertzbeat/hertzbeat>

home/blog/2022-06-22-one-step-up.md

@@ -58,13 +58,13 @@ commit;
 
 Have Fun!
 
----- 
+----
 
 ## V1.1.0
 
 Home: hertzbeat.com | tancloud.cn
 
-Hi guys! HertzBeat v1.1.0 is coming. This version we support snmp protocol and use snmp to collect windows metrics.      
+Hi guys! HertzBeat v1.1.0 is coming. This version we support snmp protocol and use snmp to collect windows metrics.
 Another major change is that we use the H2 database by default to replace the MYSQL database as storage to facilitate the installation and deployment of users. Now only one docker command is needed to install and experience hertzbeat： `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat`
 Let's Try It!
 
@@ -86,7 +86,7 @@ Bugfix.
 3. [[monitor] bugfix: fix elasticsearch collect error when need basic auth #174](https://github.com/apache/hertzbeat/pull/174) contribute by @weifuqing
 4. [Change the Oracle database name to the service name to reduce ambiguity #182](https://github.com/apache/hertzbeat/pull/182) @zklmcookle
 
-Online https://console.tancloud.cn.
+Online <https://console.tancloud.cn>.
 
 ---
 
@@ -126,5 +126,5 @@ Have Fun!
 
 **Repository Addresses**
 
-[Github](https://github.com/apache/hertzbeat) https://github.com/apache/hertzbeat      
-[Gitee](https://gitee.com/hertzbeat/hertzbeat) https://gitee.com/hertzbeat/hertzbeat
+[Github](https://github.com/apache/hertzbeat) <https://github.com/apache/hertzbeat>
+[Gitee](https://gitee.com/hertzbeat/hertzbeat) <https://gitee.com/hertzbeat/hertzbeat>

home/blog/2022-07-10-hertzbeat-v1.1.1.md

@@ -40,24 +40,23 @@ Bugfix.
 8. [[manager] 修改监控页面取消监控功能再启动监控导致多生成jobId，原有监控项目并没有真实取消 #215](https://github.com/apache/hertzbeat/pull/215) contribute by @yangshihui
 9. [[warehouse] bugfix exception when tdengine create table SQL contain special char #220](https://github.com/apache/hertzbeat/pull/220)
 
-Online https://console.tancloud.cn.
+Online <https://console.tancloud.cn>.
 
 Have Fun!
 
-----    
+----
 
-> [HertzBeat](https://github.com/apache/hertzbeat) is an opensource monitoring and alarm project incubated by [Dromara](https://dromara.org) and open sourced by [TanCloud](https://tancloud.cn), which supports Website, API, PING, Port, Database, OS Monitor etc.        
-> We also provide **[Monitoring Cloud For Saas](https://console.tancloud.cn)**, people no longer need to deploy a cumbersome monitoring tool in order to monitor their website resources. **[Sign in to get started for free](https://console.tancloud.cn)**.   
-> HertzBeat supports more liberal threshold alarm configuration (calculation expression), supports alarm notification, alarm template, email, DingDing, WeChat FeiShu and WebHook.    
-> Most important is HertzBeat supports [Custom Monitoring](https://hertzbeat.com/docs/advanced/extend-point), just by configuring the YML file, we can customize the monitoring types and metrics what we need.      
+> [HertzBeat](https://github.com/apache/hertzbeat) is an opensource monitoring and alarm project incubated by [Dromara](https://dromara.org) and open sourced by [TanCloud](https://tancloud.cn), which supports Website, API, PING, Port, Database, OS Monitor etc.
+> We also provide **[Monitoring Cloud For Saas](https://console.tancloud.cn)**, people no longer need to deploy a cumbersome monitoring tool in order to monitor their website resources. **[Sign in to get started for free](https://console.tancloud.cn)**.
+> HertzBeat supports more liberal threshold alarm configuration (calculation expression), supports alarm notification, alarm template, email, DingDing, WeChat FeiShu and WebHook.
+> Most important is HertzBeat supports [Custom Monitoring](https://hertzbeat.com/docs/advanced/extend-point), just by configuring the YML file, we can customize the monitoring types and metrics what we need.
 > HertzBeat is modular, `manager, collector, scheduler, warehouse, alerter` modules are decoupled for easy understanding and custom development.  
-> Welcome to HertzBeat's [Cloud Environment TanCloud](https://console.tancloud.cn) to try and discover more.    
+> Welcome to HertzBeat's [Cloud Environment TanCloud](https://console.tancloud.cn) to try and discover more.
 > Welcome to join us to build hertzbeat together.
 >
 > `HertzBeat`'s multi-type support, easy expansion, low coupling, hope to help developers and micro teams to quickly build their own monitoring tool.
 
 **If you like HertzBeat, star us on GitHub**
 
-[Github](https://github.com/apache/hertzbeat) https://github.com/apache/hertzbeat      
-[Gitee](https://gitee.com/hertzbeat/hertzbeat) https://gitee.com/hertzbeat/hertzbeat
-
+[Github](https://github.com/apache/hertzbeat) <https://github.com/apache/hertzbeat>
+[Gitee](https://gitee.com/hertzbeat/hertzbeat) <https://gitee.com/hertzbeat/hertzbeat>

home/blog/2022-09-04-hertzbeat-v1.1.3.md

@@ -33,11 +33,10 @@ Bugfix.
 
 1. [[docs] fix extend-http-jsonpath.md parseScript error #262](https://github.com/apache/hertzbeat/pull/262) contribute by @woshiniusange    .
 2. [[monitor] update help docs, refactor redis metrics name #264](https://github.com/apache/hertzbeat/pull/264)
-3. [[manager] bugfix alert tags is null when tags map key normal value null. #270](https://github.com/apache/hertzbeat/pull/270) issue by https://gitee.com/hello_brother_niu
-4. [[alert] bugfix: the alert global preset config do not take effect #275](https://github.com/apache/hertzbeat/pull/275) issue by https://gitee.com/hello_brother_niu
+3. [[manager] bugfix alert tags is null when tags map key normal value null. #270](https://github.com/apache/hertzbeat/pull/270) issue by <https://gitee.com/hello_brother_niu>
+4. [[alert] bugfix: the alert global preset config do not take effect #275](https://github.com/apache/hertzbeat/pull/275) issue by <https://gitee.com/hello_brother_niu>
 
-Online https://console.tancloud.cn.
+Online <https://console.tancloud.cn>.
 
-Have Fun!
+Have Fun
 ---------
-

home/blog/2022-09-10-ssl-practice.md

@@ -17,10 +17,10 @@ Today's article describes how to use hertzbeat monitoring system to detect the v
 
 HertzBeat is a real-time monitoring tool with powerful customizable monitoring capabilities without the need for an agent. Website monitoring, PING connectivity, port availability, database, OS, middleware, API monitoring, threshold alerts, alert notifications (email weChat pinning flybook).
 
-**Official website: https://hertzbeat.com | https://tancloud.cn**
+**Official website: <https://hertzbeat.com> | <https://tancloud.cn>**
 
-github: https://github.com/apache/hertzbeat    
-gitee: https://gitee.com/hertzbeat/hertzbeat
+github: <https://github.com/apache/hertzbeat>
+gitee: <https://gitee.com/hertzbeat/hertzbeat>
 
 #### Install HertzBeat
 
@@ -42,7 +42,7 @@ gitee: https://gitee.com/hertzbeat/hertzbeat
 
 2. Configure monitoring website
 
-> Here is an example to monitor Baidu website, configure the host domain name, name, collection interval, etc. > Click OK.    
+> Here is an example to monitor Baidu website, configure the host domain name, name, collection interval, etc. > Click OK.
 > Click OK. Note that ⚠️ will test the connectivity of the website before adding it by default, and it will add it only if the connection is successful, of course, you can also gray out the **Whether to test** button.
 
 ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/ad1154670648413bb82c8bdeb5b13609~tplv-k3u1fbpfcp-zoom-1.image)
@@ -87,8 +87,8 @@ gitee: https://gitee.com/hertzbeat/hertzbeat
 
 You can refer to the help file for the token configuration of Nail WeChat Flying Book, etc.
 
-https://hertzbeat.com/docs/help/alert_dingtalk   
-https://tancloud.cn/docs/help/alert_dingtalk
+<https://hertzbeat.com/docs/help/alert_dingtalk>
+<https://tancloud.cn/docs/help/alert_dingtalk>
 
 > Alert Notification -> Add new alert notification policy -> Enable notification for the recipients you just configured
 
@@ -98,10 +98,10 @@ https://tancloud.cn/docs/help/alert_dingtalk
 
 ----  
 
-#### End!
+#### End
 
 The practice of monitoring SSL certificates here, of course, for hertzbeat this function is just the tip of the iceberg, if you think hertzbeat this open source project is good if you welcome to give us in the GitHub Gitee star oh, thank you very much. Thank you for your support. The author!
 
-**github: https://github.com/apache/hertzbeat**
+**github: <https://github.com/apache/hertzbeat>**
 
-**gitee: https://gitee.com/hertzbeat/hertzbeat**
+**gitee: <https://gitee.com/hertzbeat/hertzbeat>**

home/blog/2022-10-08-hertzbeat-v1.2.0.md

@@ -45,13 +45,13 @@ Bugfixes.
 2. [[web-app] fix redirect when monitors app is null #286](https://github.com/apache/hertzbeat/pull/286)
 3. [[alerter] bugfix aviator expression match npe #297](https://github.com/apache/hertzbeat/pull/297)
 4. [[doc] fix project name error #294](https://github.com/apache/hertzbeat/pull/294) contributed by @CharlieXCL
-5. [[common]feature:use "apache.http.conn.util" replace "sun.net.util" for upgrading java version #299](https://github.com/dromara/ hertzbeat/pull/299) contributed by @Privauto
+5. [[common]feature:use "apache.http.conn.util" replace "sun.net.util" for upgrading java version #299](<https://github.com/dromara/> hertzbeat/pull/299) contributed by @Privauto
 6. [Update docker-deploy.md #304](https://github.com/apache/hertzbeat/pull/304) contributed by @emrys-he
 7. [fix(sec): upgrade snakeyaml to 1.31 #313](https://github.com/apache/hertzbeat/pull/313) contributed by @SxLiuYu
 8. [[script] add startup log and optimize port service judgment #321](https://github.com/apache/hertzbeat/pull/321)
 9. [[web-app] fix echarts y-axis value tip overflow #325](https://github.com/apache/hertzbeat/pull/325)
 10. [[webapp] fix interceptor http resp common error-msg when error #329](https://github.com/apache/hertzbeat/pull/329)
-    Online https://console.tancloud.cn.
+    Online <https://console.tancloud.cn>.
 
 Have Fun!
 
@@ -73,11 +73,11 @@ spring.
 web.
 resources: static-locations.
 static-locations.
+
 - classpath:/dist/
 - classpath:... /dist/
 
 ```
 
 ----
 ```
-

home/blog/2022-11-28-hertzbeat-v1.2.2.md

@@ -11,7 +11,7 @@ tags: [opensource]
 
 Home: hertzbeat.com | tancloud.cn
 
-Hi guys! HertzBeat v1.2.2 is coming. This release brings significant features. This version we support monitor kubernetes, docker, springboot, nacos and database dm, opengauss and more. Also we bring an experimental feature, users can custom define metrics collect from prometheus with promql. Fixed several bugs and improved the overall stable usability. And more, linux monitor we support top10 cpu usage metrics, top10 memory usage metrics.   
+Hi guys! HertzBeat v1.2.2 is coming. This release brings significant features. This version we support monitor kubernetes, docker, springboot, nacos and database dm, opengauss and more. Also we bring an experimental feature, users can custom define metrics collect from prometheus with promql. Fixed several bugs and improved the overall stable usability. And more, linux monitor we support top10 cpu usage metrics, top10 memory usage metrics.
 Let's Try It Now!
 
 Only one docker command is needed to install and experience heartbeat：
@@ -51,11 +51,11 @@ Bugfix.
 6. [[manager] bugfix the gmtUpdate not change when update monitor param #459](https://github.com/apache/hertzbeat/pull/459)
 7. [[home] fix typo in springboot2.md #464](https://github.com/apache/hertzbeat/pull/464) @eltociear
 
-Online https://console.tancloud.cn.
+Online <https://console.tancloud.cn>.
 
 Have Fun!
 
-----     
+----
 
 ## V1.2.2
 
@@ -100,5 +100,4 @@ Bugfix.
 6. [[manager] bugfix the gmtUpdate not change when update monitor param #459](https://github.com/apache/hertzbeat/pull/459)
 7. [[home] fix typo in springboot2.md #464](https://github.com/apache/hertzbeat/pull/464) @eltociear
 
-----     
-
+----

home/blog/2022-12-19-new-committer.md

@@ -57,7 +57,7 @@ github：[wang1027-wqh](https://github.com/wang1027-wqh)
 
 现从事：某互联网公司Java开发工程师
 
-email：[email protected]
+email：<[email protected]>
 
 Hertzbeat Committer
 
@@ -105,4 +105,3 @@ github：[Ceilzcx (zcx) (github.com)](https://github.com/Ceilzcx)
 + 如果是大的改动，建议提交前编写issues，在提交pr，同时请注意编码的规范，尽量减少bug和警告的产生
 
 > 以上就是我们新晋Committer们的开源经历了，可以看出参与开源并不难，更重要的是迈出第一步，无论是代码还是文档修复或者提交issue，这些都是贡献者参与开源的姿势。快来加入我们吧！
-

home/blog/2022-12-28-hertzbeat-v1.2.3.md

@@ -49,11 +49,11 @@ Bugfix.
 7. [监控k8s问题issue描述与解决方案 #511](https://github.com/apache/hertzbeat/pull/511) @MrAndyMing
 8. [[manager] springboot2 monitor support base path config #515](https://github.com/apache/hertzbeat/pull/515)
 
-Online https://console.tancloud.cn.
+Online <https://console.tancloud.cn>.
 
 Have Fun!
 
-----     
+----
 
 ## V1.2.3
 
@@ -95,5 +95,4 @@ Bugfix.
 7. [监控k8s问题issue描述与解决方案 #511](https://github.com/apache/hertzbeat/pull/511) @MrAndyMing
 8. [[manager] springboot2 monitor support base path config #515](https://github.com/apache/hertzbeat/pull/515)
 
-----     
-
+----