[feature] support dead link check (apache#2579)

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

Author: zhangshenghang

.github/exclude_files.txt

@@ -0,0 +1,44 @@
+./home/versioned_docs/version-v1.5.x/community/how-to-release.md
+./home/versioned_docs/version-v1.5.x/start/postgresql-change.md
+./home/versioned_docs/version-v1.4.x/start/postgresql-change.md
+./home/versioned_docs/version-v1.5.x/introduce.md
+./home/versioned_docs/version-v1.4.x/introduce.md
+./home/versioned_docs/version-v1.5.x/help/sqlserver.md
+./home/versioned_docs/version-v1.4.x/help/sqlserver.md
+./home/versioned_docs/version-v1.5.x/help/alert_threshold_expr.md
+./home/versioned_docs/version-v1.4.x/help/alert_threshold_expr.md
+./home/versioned_docs/version-v1.4.x/others/resource.md
+./home/versioned_docs/version-v1.5.x/others/resource.md
+./home/docs/community/how-to-release.md
+./home/blog/2022-06-01-hertzbeat-v1.0.md
+./home/blog/2023-12-11-hertzbeat-v1.4.3.md
+./home/blog/2023-11-12-hertzbeat-v1.4.2.md
+./home/blog/2024-01-18-hertzbeat-v1.4.4.md
+./home/docs/introduce.md
+./home/docs/help/sqlserver.md
+./home/docs/postgresql-change.md
+./home/docs/help/alert_threshold_expr.md
+./home/docs/others/resource.md
+./home/i18n/zh-cn/docusaurus-plugin-content-docs/current/introduce.md
+./home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/sqlserver.md
+./home/i18n/zh-cn/docusaurus-plugin-content-docs/current/postgresql-change.md
+./home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_threshold_expr.md
+./home/i18n/zh-cn/docusaurus-plugin-content-docs/current/others/resource.md
+./home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-11-12-hertzbeat-v1.4.2.md
+./home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-06-01-hertzbeat-v1.0.md
+./home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-12-11-hertzbeat-v1.4.3.md
+./home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-01-18-hertzbeat-v1.4.4.md
+./home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/how-to-release.md
+./home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/postgresql-change.md
+./home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/postgresql-change.md
+./home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/introduce.md
+./home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/introduce.md
+./home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/sqlserver.md
+./home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/sqlserver.md
+./home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_threshold_expr.md
+./home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_threshold_expr.md
+./home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/resource.md
+./home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/others/resource.md
+./home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/tdengine-init.md
+./home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/tdengine-init.md
+./home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/tdengine-init.md

.github/link_check.json

@@ -0,0 +1,20 @@
+{
+  "ignorePatterns": [
+    {
+      "pattern": "^(?!http).*"
+    },
+    {
+      "pattern": "!\\[.*\\]\\((?!http).*\\)"
+    }
+  ],
+  "timeout": "10s",
+  "retryOn429": true,
+  "retryCount": 10,
+  "fallbackRetryDelay": "1000s",
+  "aliveStatusCodes": [
+    0,
+    200,
+    401,
+    403
+  ]
+}

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

@@ -114,6 +114,14 @@ jobs:
           else
             echo "All file names are valid."
           fi
+      - name: Dead Link
+        run: |
+          sudo npm install -g [email protected]
+          for file in $(find ./home -name "*.md"); do
+            if ! grep -Fxq "$file" .github/exclude_files.txt; then
+              markdown-link-check -c .github/link_check.json -q "$file"
+            fi
+          done
       - name: NPM INSTALL
         working-directory: home
         run: npm install

home/docs/start/upgrade.md

@@ -24,23 +24,23 @@ Apache HertzBeat (incubating)'s metadata information is stored in H2 or Mysql, P
 2. If using the built-in default H2 database
    - Need to mount or back up `-v $(pwd)/data:/opt/hertzbeat/data` database file directory in the container `/opt/hertzbeat/data`
    - Stop and delete the container, delete the local HertzBeat docker image, and pull the new version image
-   - Refer to [Docker installation of HertzBeat](docker-deploy) to create a new container using a new image. Note that the database file directory needs to be mounted `-v $(pwd)/data:/opt/hertzbeat/data`
+   - Refer to [Docker installation of HertzBeat](./docker-deploy) to create a new container using a new image. Note that the database file directory needs to be mounted `-v $(pwd)/data:/opt/hertzbeat/data`
 3. If using external relational database Mysql, PostgreSQL
    - No need to mount the database file directory in the backup container
    - Stop and delete the container, delete the local HertzBeat docker image, and pull the new version image
-   - Refer to [Docker installation HertzBeat](docker-deploy) to create a new container using the new image, and configure the database connection in `application.yml`
+   - Refer to [Docker installation HertzBeat](./docker-deploy) to create a new container using the new image, and configure the database connection in `application.yml`
 
 ### Upgrade For Package Deploy
 
 1. If using the built-in default H2 database
    - Back up the database file directory under the installation package `/opt/hertzbeat/data`
    - If there is a custom monitoring template, you need to back up the template YML under `/opt/hertzbeat/define`
    - `bin/shutdown.sh` stops the HertzBeat process and downloads the new installation package
-   - Refer to [Installation package to install HertzBeat](package-deploy) to start using the new installation package
+   - Refer to [Installation package to install HertzBeat](./package-deploy) to start using the new installation package
 2. If using external relational database Mysql, PostgreSQL
    - No need to back up the database file directory under the installation package
    - If there is a custom monitoring template, you need to back up the template YML under `/opt/hertzbeat/define`
    - `bin/shutdown.sh` stops the HertzBeat process and downloads the new installation package
-   - Refer to [Installation package to install HertzBeat](package-deploy) to start with the new installation package and configure the database connection in `application.yml`
+   - Refer to [Installation package to install HertzBeat](./package-deploy) to start with the new installation package and configure the database connection in `application.yml`
 
 **HAVE FUN**

script/docker-compose/hertzbeat-mysql-iotdb/README.md

@@ -15,7 +15,7 @@
 ##### docker compose deploys hertzbeat and its dependent services
 
 1. Download the hertzbeat-docker-compose installation deployment script file
-   The script file is located in `script/docker-compose/hertzbeat-mysql-iotdb` link [script/docker-compose](https://github.com/hertzbeat/hertzbeat/tree/master/script/docker-compose/ hertzbeat-mysql-iotdb)
+   The script file is located in `script/docker-compose/hertzbeat-mysql-iotdb` link [script/docker-compose](https://github.com/apache/hertzbeat/tree/master/script/docker-compose/ hertzbeat-mysql-iotdb)
 
 2. Add MYSQL jdbc driver jar
 

script/docker-compose/hertzbeat-mysql-iotdb/README_CN.md

@@ -17,7 +17,7 @@
 ##### docker compose部署hertzbeat及其依赖服务     
 
 1. 下载hertzbeat-docker-compose安装部署脚本文件  
-   脚本文件位于代码仓库下`script/docker-compose/hertzbeat-mysql-iotdb` 链接 [script/docker-compose](https://github.com/hertzbeat/hertzbeat/tree/master/script/docker-compose/hertzbeat-mysql-iotdb)
+   脚本文件位于代码仓库下`script/docker-compose/hertzbeat-mysql-iotdb` 链接 [script/docker-compose](https://github.com/apache/hertzbeat/tree/master/script/docker-compose/hertzbeat-mysql-iotdb)
 
 2. 添加 MYSQL jdbc 驱动 jar
    下载 MYSQL jdbc driver jar, 例如 mysql-connector-java-8.0.25.jar. https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.25.zip

script/docker-compose/hertzbeat-mysql-tdengine/README.md

@@ -15,7 +15,7 @@
 ##### docker compose deploys hertzbeat and its dependent services
 
 1. Download the hertzbeat-docker-compose installation deployment script file
-   The script file is located in `script/docker-compose/hertzbeat-mysql-tdengine` link [script/docker-compose](https://github.com/hertzbeat/hertzbeat/tree/master/script/docker-compose/hertzbeat-mysql-tdengine)
+   The script file is located in `script/docker-compose/hertzbeat-mysql-tdengine` link [script/docker-compose](https://github.com/apache/hertzbeat/tree/master/script/docker-compose/hertzbeat-mysql-tdengine)
 
 2. Add MYSQL jdbc driver jar
 

script/docker-compose/hertzbeat-mysql-tdengine/README_CN.md

@@ -17,7 +17,7 @@
 ##### docker compose部署hertzbeat及其依赖服务     
 
 1. 下载hertzbeat-docker-compose安装部署脚本文件  
-   脚本文件位于代码仓库下`script/docker-compose/hertzbeat-mysql-tdengine` 链接 [script/docker-compose](https://github.com/hertzbeat/hertzbeat/tree/master/script/docker-compose/hertzbeat-mysql-tdengine)   
+   脚本文件位于代码仓库下`script/docker-compose/hertzbeat-mysql-tdengine` 链接 [script/docker-compose](https://github.com/apache/hertzbeat/tree/master/script/docker-compose/hertzbeat-mysql-tdengine)   
 
 2. 添加 MYSQL jdbc 驱动 jar
    下载 MYSQL jdbc driver jar, 例如 mysql-connector-java-8.0.25.jar. https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.25.zip

script/docker-compose/hertzbeat-mysql-victoria-metrics/README.md

@@ -15,7 +15,7 @@
 ##### docker compose deploys hertzbeat and its dependent services
 
 1. Download the hertzbeat-docker-compose installation deployment script file
-   The script file is located in `script/docker-compose/hertzbeat-mysql-victoria-metrics` link [script/docker-compose](https://github.com/hertzbeat/hertzbeat/tree/master/script/docker-compose/hertzbeat-mysql-victoria-metrics)
+   The script file is located in `script/docker-compose/hertzbeat-mysql-victoria-metrics` link [script/docker-compose](https://github.com/apache/hertzbeat/tree/master/script/docker-compose/hertzbeat-mysql-victoria-metrics)
 
 2. Add MYSQL jdbc driver jar
 

script/docker-compose/hertzbeat-mysql-victoria-metrics/README_CN.md

@@ -17,7 +17,7 @@
 ##### docker compose部署hertzbeat及其依赖服务     
 
 1. 下载hertzbeat-docker-compose安装部署脚本文件  
-   脚本文件位于代码仓库下`script/docker-compose/hertzbeat-mysql-victoria-metrics` 链接 [script/docker-compose](https://github.com/hertzbeat/hertzbeat/tree/master/script/docker-compose/hertzbeat-mysql-mysql-victoria-metrics)   
+   脚本文件位于代码仓库下`script/docker-compose/hertzbeat-mysql-victoria-metrics` 链接 [script/docker-compose](https://github.com/apache/hertzbeat/tree/master/script/docker-compose/hertzbeat-mysql-victoria-metrics)   
 
 2. 添加 MYSQL jdbc 驱动 jar
    下载 MYSQL jdbc driver jar, 例如 mysql-connector-java-8.0.25.jar. https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.25.zip

script/docker-compose/hertzbeat-postgresql-victoria-metrics/README_CN.md

@@ -17,7 +17,7 @@
 ##### docker compose部署hertzbeat及其依赖服务     
 
 1. 下载hertzbeat-docker-compose安装部署脚本文件  
-   脚本文件位于代码仓库下`script/docker-compose/hertzbeat-postgre-victoria-metrics` 链接 [script/docker-compose](https://github.com/apache/hertzbeat/tree/master/script/docker-compose/hertzbeat-postgre-victoria-metrics)   
+   脚本文件位于代码仓库下`script/docker-compose/hertzbeat-postgre-victoria-metrics` 链接 [script/docker-compose](https://github.com/apache/hertzbeat/tree/master/script/docker-compose/hertzbeat-postgresql-victoria-metrics)   
 
 
 2. 进入部署脚本 docker-compose 目录, 执行