[Improve] remove 1.4 version doc and improve markdown format for MD001 (

apache#2585) Co-authored-by: Jast <[email protected]>
Aias00 · Aug 23, 2024 · b602d8c · b602d8c
1 parent bad28bc
commit b602d8c
Show file tree

Hide file tree

Showing 224 changed files with 90 additions and 18,622 deletions.
diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc
@@ -17,7 +17,7 @@
 {
   "config": {
     "default": true,
-    "MD001": false,
+    "MD001": true,
     "MD052": false,
     "MD003": false,
     "MD013": false,
@@ -36,6 +36,8 @@
     "MD047": false
   },
   "ignore": [
-    "node_modules/"
+    "node_modules/",
+    "target/",
+    "dist/"
   ]
 }
diff --git a/home/docs/community/how-to-release.md b/home/docs/community/how-to-release.md
@@ -168,6 +168,8 @@ $ svn ci -m "add gpg key for muchunjin"
 
 ## 3. Prepare material package & release
 
+### Build Package
+
 #### 3.1 Based on the master branch, create a release-${release_version}-rcx branch, such as release-1.6.0-rc1, And create a tag named v1.6.0-rc1 based on the release-1.6.0-rc1 branch, and set this tag as pre-release
 
 ```shell
@@ -228,6 +230,8 @@ release-1.6.0-rc1
 
 The archive package is here `dist/apache-hertzbeat-1.6.0-incubating-src.tar.gz`
 
+### Sign package
+
 #### 3.5 Sign binary and source packages
 
 > The `gpg -u 33545C76`  `33545C76` is your gpg secret ID, see from `gpg --keyid-format SHORT --list-keys`
@@ -333,7 +337,7 @@ svn commit -m "release for HertzBeat 1.6.0"
 
 ## 4. Enter the community voting stage
 
-#### 4.1 Send a Community Vote Email
+### 4.1 Send a Community Vote Email
 
 Send a voting email in the community requires at least three `+1` and no `-1`.
 
@@ -525,9 +529,9 @@ One item of the email content is `Vote thread`, and the link is obtained here: <
 
 Wait a day to see if the tutor has any other comments, if not, send the following announcement email
 
-## 4. Complete the final publishing steps
+## 5. Complete the final publishing steps
 
-#### 4.1 Migrating source and binary packages
+### 5.1 Migrating source and binary packages
 
 ```shell
 svn mv https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/1.6.0-RC1 https://dist.apache.org/repos/dist/release/incubator/hertzbeat/1.6.0  -m "transfer packages for 1.6.0-RC1"

diff --git a/home/docs/help/flink_on_yarn.md b/home/docs/help/flink_on_yarn.md
@@ -2,7 +2,7 @@
 
 > Measurement and monitoring of general metrics for Flink stream engine in Yarn running mode.
 
-### Configuration Parameters
+## Configuration Parameters
 
 |   Parameter Name    |                                             Parameter Help Description                                              |
 |---------------------|---------------------------------------------------------------------------------------------------------------------|

diff --git a/home/docs/help/greenplum.md b/home/docs/help/greenplum.md
@@ -53,4 +53,3 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo
 | Metric name | Metric unit |       Metric help description        |
 |-------------|-------------|--------------------------------------|
 | running     | connections | Number of current client connections |
-
diff --git a/home/docs/help/kubernetes.md b/home/docs/help/kubernetes.md
@@ -13,7 +13,7 @@ If you want to monitor the information in 'Kubernetes', you need to obtain an au
 
 Refer to the steps to obtain token
 
-#### method one
+### method one
 
 1. Create a service account and bind the default cluster-admin administrator cluster role
 
@@ -27,7 +27,7 @@ kubectl -n kube-system get secret | grep dashboard-admin | awk '{print $1}'
 kubectl describe secret {secret} -n kube-system
 ```
 
-#### method two
+### method two
 
 ```shell
 kubectl create serviceaccount cluster-admin

diff --git a/home/docs/help/vastbase.md b/home/docs/help/vastbase.md
@@ -53,4 +53,3 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo
 | Metric name | Metric unit |       Metric help description        |
 |-------------|-------------|--------------------------------------|
 | running     | connections | Number of current client connections |
-
diff --git a/home/docs/start/quickstart.md b/home/docs/start/quickstart.md
@@ -8,7 +8,7 @@ sidebar_label: Quick Start
 
 - If you wish to deploy Apache HertzBeat (incubating) locally, please refer to the following Deployment Documentation for instructions.
 
-### 🍞 Install HertzBeat
+#### 🍞 Install HertzBeat
 
 > Apache HertzBeat (incubating) supports installation through source code, docker or package, cpu support X86/ARM64.
 

diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.4.x.json b/home/i18n/en/docusaurus-plugin-content-docs/version-v1.4.x.json
diff --git a/...i18n/zh-cn/docusaurus-plugin-content-blog/2024-06-11-hertzbeat-v1.6.0-update.md b/...i18n/zh-cn/docusaurus-plugin-content-blog/2024-06-11-hertzbeat-v1.6.0-update.md
@@ -1,4 +1,4 @@
-# HertzBeat 1.6.0 升级指南
+## HertzBeat 1.6.0 升级指南
 
 ### 注意：该指南适用于1.5.0向1.6.0版本升级
 

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
@@ -168,6 +168,8 @@ $ svn ci -m "add gpg key for muchunjin"
 
 ## 3. 准备物料 & 发布
 
+### 准备发布物料
+
 #### 3.1 基于 master 分支，创建一个名为 release-${release_version}-rcx 的分支，例如 release-1.6.0-rc1。并基于 release-1.6.0-rc1 分支创建一个名为 v1.6.0-rc1 的标签，并将此标签设置为预发布
 
 ```shell
@@ -228,6 +230,8 @@ release-1.6.0-rc1
 
 生成的代码归档文件在 `dist/apache-hertzbeat-1.6.0-incubating-src.tar.gz`
 
+### 签名发布物料
+
 #### 3.5 对二进制和源码包进行签名
 
 将上步骤生成的三个文件包放到`dist`目录下(若无则新建目录)，然后对文件包进行签名和SHA512校验和生成。
@@ -335,7 +339,7 @@ svn commit -m "release for HertzBeat 1.6.0-RC1"
 
 ## 4. 进入社区投票阶段
 
-#### 4.1 发送社区投票邮件
+### 4.1 发送社区投票邮件
 
 发送社区投票邮件需要至少三个`+1`，且无`-1`。
 
@@ -426,7 +430,7 @@ ChunJin Mu
 
 邮件内容中的一项是`Vote thread`，在 <https://lists.apache.org/[email protected]> 查看获取
 
-#### 3.2 发送孵化社区投票邮件
+### 3.2 发送孵化社区投票邮件
 
 发送孵化社区投票邮件需要至少三个`+1`，且无`-1`。
 
@@ -529,13 +533,13 @@ ChunJin Mu
 
 ## 4. 完成最终发布步骤
 
-#### 4.1 迁移源代码和二进制包
+### 4.1 迁移源代码和二进制包
 
 ```shell
 svn mv https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/1.6.0-RC1 https://dist.apache.org/repos/dist/release/incubator/hertzbeat/1.6.0  -m "transfer packages for 1.6.0-RC1"
 ```
 
-#### 4.2 添加新版本下载地址到官网
+### 4.2 添加新版本下载地址到官网
 
 <https://github.com/apache/hertzbeat/blob/master/home/docs/download.md>
 <https://github.com/apache/hertzbeat/blob/master/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/download.md>
@@ -544,7 +548,7 @@ svn mv https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/1.6.0-RC1 http
 
 > 需要注意的是，下载链接可能需要一个小时后才会生效，请注意。
 
-#### 4.3 Github 生成 Release
+### 4.3 Github 生成 Release
 
 基于 release-1.6.0-rc1 分支修改创建一个名为 v1.6.0 的标签，并将此标签设置为 latest release。
 
@@ -571,7 +575,7 @@ release note: xxx
 
 然后将 release-1.6.0-rc1 分支重命名 为 release-1.6.0。
 
-#### 4.4 发送新版本公告邮件
+### 4.4 发送新版本公告邮件
 
 > `Send to`: <[email protected]> <br />
 > `cc`: <[email protected]> <br />

diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dns.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dns.md
@@ -5,7 +5,7 @@ sidebar_label: DNS服务器
 keywords: [ 开源监控系统, 开源DNS监控工具, 监控DNS指标 ]
 ---
 
-# 监控：DNS服务器
+## 监控：DNS服务器
 
 > 收集和监控DNS的常规性能指标。
 

diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/greenplum.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/greenplum.md
@@ -53,4 +53,3 @@ keywords: [开源监控系统, 开源数据库监控, GreenPlum 数据库监控]
 |  指标名称   | 指标单位 |  指标帮助描述  |
 |---------|------|----------|
 | running | 连接数  | 当前客户端连接数 |
-
diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kubernetes.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kubernetes.md
@@ -13,7 +13,7 @@ keywords: [开源监控系统, 开源Kubernetes监控]
 
 参考获取token步骤
 
-#### 方式一
+### 方式一
 
 1. 创建service account并绑定默认cluster-admin管理员集群角色
 
@@ -27,7 +27,7 @@ kubectl -n kube-system get secret | grep dashboard-admin | awk '{print $1}'
 kubectl describe secret {secret} -n kube-system
 ```
 
-#### 方式二
+### 方式二
 
 ```
 kubectl create serviceaccount cluster-admin

diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ntp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ntp.md
@@ -7,7 +7,7 @@ keywords: [ open source monitoring tool, open source NTP monitoring tool, monito
 
 NTP监控的中文文档如下：
 
-# NTP监控
+## NTP监控
 
 > 收集和监控NTP的常规性能指标。
 

diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/vastbase.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/vastbase.md
@@ -53,4 +53,3 @@ keywords: [开源监控系统, 开源数据库监控, Vastbase 数据库监控]
 |  指标名称   | 指标单位 |  指标帮助描述  |
 |---------|------|----------|
 | running | 连接数  | 当前客户端连接数 |
-
diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/update-1.6.0.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/update-1.6.0.md
@@ -4,7 +4,7 @@ title: 如何升级到1.6.0
 sidebar_label: 1.6.0升级指南
 ---
 
-# HertzBeat 1.6.0 升级指南
+## HertzBeat 1.6.0 升级指南
 
 ### 注意：该指南适用于1.5.0向1.6.0版本升级
Original file line number	Diff line number	Diff line change
Expand Up		@@ -53,4 +53,3 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo
		\| Metric name \| Metric unit \| Metric help description \|
		\|-------------\|-------------\|--------------------------------------\|
		\| running \| connections \| Number of current client connections \|
Original file line number	Diff line number	Diff line change
Expand Up		@@ -53,4 +53,3 @@ keywords: [开源监控系统, 开源数据库监控, GreenPlum 数据库监控]
		\| 指标名称 \| 指标单位 \| 指标帮助描述 \|
		\|---------\|------\|----------\|
		\| running \| 连接数 \| 当前客户端连接数 \|