This is an automated email from the ASF dual-hosted git repository.
gongchao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/hertzbeat.git
The following commit(s) were added to refs/heads/master by this push:
new d056ce2aa [feature] support dead link check (#2579)
d056ce2aa is described below
commit d056ce2aa69ee9af40813517c77137fc01546a03
Author: Jast <[email protected]>
AuthorDate: Wed Aug 21 23:19:14 2024 +0800
[feature] support dead link check (#2579)
Co-authored-by: tomsun28 <[email protected]>
---
.github/exclude_files.txt | 44 ++++++++++++++++++++++
.github/link_check.json | 20 ++++++++++
.github/workflows/doc-build-test.yml | 8 ++++
home/docs/start/upgrade.md | 8 ++--
.../docker-compose/hertzbeat-mysql-iotdb/README.md | 2 +-
.../hertzbeat-mysql-iotdb/README_CN.md | 2 +-
.../hertzbeat-mysql-tdengine/README.md | 2 +-
.../hertzbeat-mysql-tdengine/README_CN.md | 2 +-
.../hertzbeat-mysql-victoria-metrics/README.md | 2 +-
.../hertzbeat-mysql-victoria-metrics/README_CN.md | 2 +-
.../README_CN.md | 2 +-
11 files changed, 83 insertions(+), 11 deletions(-)
diff --git a/.github/exclude_files.txt b/.github/exclude_files.txt
new file mode 100644
index 000000000..ce60d627e
--- /dev/null
+++ b/.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
\ No newline at end of file
diff --git a/.github/link_check.json b/.github/link_check.json
new file mode 100644
index 000000000..7091f3937
--- /dev/null
+++ b/.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
+ ]
+}
diff --git a/.github/workflows/doc-build-test.yml
b/.github/workflows/doc-build-test.yml
index e8b750618..670da80af 100644
--- a/.github/workflows/doc-build-test.yml
+++ b/.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
diff --git a/home/docs/start/upgrade.md b/home/docs/start/upgrade.md
index ebd4af61e..63f048ca1 100644
--- a/home/docs/start/upgrade.md
+++ b/home/docs/start/upgrade.md
@@ -24,11 +24,11 @@ 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
@@ -36,11 +36,11 @@ Apache HertzBeat (incubating)'s metadata information is
stored in H2 or Mysql, P
- 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**
diff --git a/script/docker-compose/hertzbeat-mysql-iotdb/README.md
b/script/docker-compose/hertzbeat-mysql-iotdb/README.md
index 851016b5a..b5b94efce 100644
--- a/script/docker-compose/hertzbeat-mysql-iotdb/README.md
+++ b/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
diff --git a/script/docker-compose/hertzbeat-mysql-iotdb/README_CN.md
b/script/docker-compose/hertzbeat-mysql-iotdb/README_CN.md
index cc290c720..9f145fe76 100644
--- a/script/docker-compose/hertzbeat-mysql-iotdb/README_CN.md
+++ b/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
diff --git a/script/docker-compose/hertzbeat-mysql-tdengine/README.md
b/script/docker-compose/hertzbeat-mysql-tdengine/README.md
index d8b165f17..27c1febab 100644
--- a/script/docker-compose/hertzbeat-mysql-tdengine/README.md
+++ b/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
diff --git a/script/docker-compose/hertzbeat-mysql-tdengine/README_CN.md
b/script/docker-compose/hertzbeat-mysql-tdengine/README_CN.md
index 0f9f097c7..329344585 100644
--- a/script/docker-compose/hertzbeat-mysql-tdengine/README_CN.md
+++ b/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
diff --git a/script/docker-compose/hertzbeat-mysql-victoria-metrics/README.md
b/script/docker-compose/hertzbeat-mysql-victoria-metrics/README.md
index 77227db01..02a6829ea 100644
--- a/script/docker-compose/hertzbeat-mysql-victoria-metrics/README.md
+++ b/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
diff --git
a/script/docker-compose/hertzbeat-mysql-victoria-metrics/README_CN.md
b/script/docker-compose/hertzbeat-mysql-victoria-metrics/README_CN.md
index 3e2902385..6602b34a3 100644
--- a/script/docker-compose/hertzbeat-mysql-victoria-metrics/README_CN.md
+++ b/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
diff --git
a/script/docker-compose/hertzbeat-postgresql-victoria-metrics/README_CN.md
b/script/docker-compose/hertzbeat-postgresql-victoria-metrics/README_CN.md
index 88d6ae2f6..f809587e0 100644
--- a/script/docker-compose/hertzbeat-postgresql-victoria-metrics/README_CN.md
+++ b/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 目录, 执行
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
