This is an automated email from the ASF dual-hosted git repository. gongchao pushed a commit to branch home-fix1 in repository https://gitbox.apache.org/repos/asf/hertzbeat.git
commit 8c2cd8a2e4f3b5e6622e89a131c23426a8734465 Author: tomsun28 <[email protected]> AuthorDate: Thu Aug 22 22:42:47 2024 +0800 [doc] fix mdlint and remove 1.4 doc --- .../version-v1.5.x/community/how-to-release.md | 34 ++++++++++++++-------- .../version-v1.5.x/help/dns.md | 2 +- .../version-v1.5.x/help/kubernetes.md | 4 +-- .../version-v1.5.x/help/ntp.md | 2 +- .../version-v1.5.x/start/quickstart.md | 2 +- .../version-v1.5.x/community/how-to-release.md | 29 +++++++++++------- home/versioned_docs/version-v1.5.x/help/dns.md | 6 ++-- .../version-v1.5.x/help/kubernetes.md | 4 +-- home/versioned_docs/version-v1.5.x/help/ntp.md | 2 +- .../version-v1.5.x/start/quickstart.md | 2 +- 10 files changed, 53 insertions(+), 34 deletions(-) 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 index 5eabbc561..5402bc696 100644 --- 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 @@ -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,23 +575,29 @@ 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 /> -> `Title`: [ANNOUNCE] Release Apache HertzBeat (incubating) 1.6.0 <br /> +> `Title`: [ANNOUNCE] Apache HertzBeat (incubating) 1.6.0 released <br /> > `Body`: ``` -Hi Incubator Community, +Hi Community, We are glad to announce the release of Apache HertzBeat (incubating) 1.6.0. -Once again I would like to express my thanks to your help. +Thanks again for your help. + +Apache HertzBeat (https://hertzbeat.apache.org/) - a real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities. + +Download Link: +https://hertzbeat.apache.org/docs/download/ -Apache HertzBeat(https://hertzbeat.apache.org/) - a real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities. +Release Note: +https://github.com/apache/hertzbeat/releases/tag/v1.6.0 -Download Links: https://hertzbeat.apache.org/download/ -Release Notes: https://github.com/apache/hertzbeat/releases/tag/v1.6.0 +Website: +https://hertzbeat.apache.org/ HertzBeat Resources: - Issue: https://github.com/apache/hertzbeat/issues diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dns.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dns.md index 386ec0e91..e012e347c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dns.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/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/version-v1.5.x/help/kubernetes.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kubernetes.md index 4f0363f62..cc4c7254a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kubernetes.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/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/version-v1.5.x/help/ntp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ntp.md index a160f2501..0806232ce 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ntp.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/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/version-v1.5.x/start/quickstart.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/quickstart.md index 85756d3df..07d5a8b8e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/quickstart.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/quickstart.md @@ -87,7 +87,7 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN **HAVE FUN** -### 🐵 依赖服务部署(可选) +#### 🐵 依赖服务部署(可选) > HertzBeat依赖于 **关系型数据库** H2(默认已内置无需安装) 或 [Mysql](mysql-change) 和 **时序性数据库** > [TDengine2+](tdengine-init) 或 [IOTDB](iotdb-init) (可选) 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 index 71583c0d3..94c919d30 100644 --- 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 @@ -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" @@ -573,27 +577,32 @@ The rename the release-1.6.0-rc1 branch to release-1.6.0. > `Send to`: <[email protected]> <br /> > `cc`: <[email protected]> <br /> -> `Title`: [ANNOUNCE] Release Apache HertzBeat (incubating) 1.6.0 <br /> +> `Title`: [ANNOUNCE] Apache HertzBeat (incubating) 1.6.0 released <br /> > `Body`: ``` -Hi Incubator Community, +Hi Community, We are glad to announce the release of Apache HertzBeat (incubating) 1.6.0. -Once again I would like to express my thanks to your help. +Thanks again for your help. -Apache HertzBeat(https://hertzbeat.apache.org/) - a real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities. +Apache HertzBeat (https://hertzbeat.apache.org/) - a real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities. -Download Links: https://hertzbeat.apache.org/download/ +Download Link: +https://hertzbeat.apache.org/docs/download/ -Release Notes: https://github.com/apache/hertzbeat/releases/tag/v1.6.0 +Release Note: +https://github.com/apache/hertzbeat/releases/tag/v1.6.0 + +Website: +https://hertzbeat.apache.org/ HertzBeat Resources: - Issue: https://github.com/apache/hertzbeat/issues - Mailing list: [email protected] --- Apache HertzBeat Team - +--- Best, ChunJin Mu ``` diff --git a/home/versioned_docs/version-v1.5.x/help/dns.md b/home/versioned_docs/version-v1.5.x/help/dns.md index 3d6a5fe4b..5eb318446 100644 --- a/home/versioned_docs/version-v1.5.x/help/dns.md +++ b/home/versioned_docs/version-v1.5.x/help/dns.md @@ -9,7 +9,7 @@ keywords: [ open source monitoring tool, open source DNS monitoring tool, monito **Protocol Use：DNS** -### Configuration parameter +## Configuration parameter | Parameter name | Parameter help description | |---------------------|--------------------------------------------------------------------------------------------------------------------------| @@ -24,9 +24,9 @@ keywords: [ open source monitoring tool, open source DNS monitoring tool, monito | Bind Tags | Used to classify and manage monitoring resources. | | Description remarks | For more information about identifying and describing this monitoring, users can note information here. | -### Collection Metrics +## Collection Metrics -#### Metrics Set：Header +### Metrics Set：Header | Metric name | Metric unit | Metric help description | |-------------------------|-------------|---------------------------------------------------| diff --git a/home/versioned_docs/version-v1.5.x/help/kubernetes.md b/home/versioned_docs/version-v1.5.x/help/kubernetes.md index 3cb2336e7..d7e6b657e 100644 --- a/home/versioned_docs/version-v1.5.x/help/kubernetes.md +++ b/home/versioned_docs/version-v1.5.x/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/versioned_docs/version-v1.5.x/help/ntp.md b/home/versioned_docs/version-v1.5.x/help/ntp.md index fc7f7925c..3c3abeee5 100644 --- a/home/versioned_docs/version-v1.5.x/help/ntp.md +++ b/home/versioned_docs/version-v1.5.x/help/ntp.md @@ -9,7 +9,7 @@ keywords: [ open source monitoring tool, open source NTP monitoring tool, monito **Protocol Use：NTP** -### Configuration parameter +## Configuration parameter | Parameter name | Parameter help description | |---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| diff --git a/home/versioned_docs/version-v1.5.x/start/quickstart.md b/home/versioned_docs/version-v1.5.x/start/quickstart.md index 6cbaffc43..319e046b2 100644 --- a/home/versioned_docs/version-v1.5.x/start/quickstart.md +++ b/home/versioned_docs/version-v1.5.x/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. --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
