This is an automated email from the ASF dual-hosted git repository.
shown 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 cc60f8453b docs: fix the sidebars i18n and version display, add auto
deploy action (#4018)
cc60f8453b is described below
commit cc60f8453b487ab4834b51ae36cb674907365dc2
Author: Tomsun28 <[email protected]>
AuthorDate: Sun Feb 8 22:14:05 2026 +0800
docs: fix the sidebars i18n and version display, add auto deploy action
(#4018)
Signed-off-by: tomsun28 <[email protected]>
---
.github/workflows/doc-deploy.yml | 82 +++++++++++++++
home/docusaurus.config.js | 4 +-
.../version-1.8.0.json | 110 +++++++++------------
.../version-1.8.0.json | 2 +-
4 files changed, 130 insertions(+), 68 deletions(-)
diff --git a/.github/workflows/doc-deploy.yml b/.github/workflows/doc-deploy.yml
new file mode 100644
index 0000000000..bb66c8f861
--- /dev/null
+++ b/.github/workflows/doc-deploy.yml
@@ -0,0 +1,82 @@
+# 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.
+
+name: DOC Deploy
+
+on:
+ # Trigger on push to master branch when home directory files are changed
+ push:
+ branches: [ master ]
+ paths:
+ - 'home/**'
+
+ # Allow manual workflow trigger
+ workflow_dispatch:
+
+# Set permissions for deployment
+permissions:
+ contents: write
+
+jobs:
+ deploy:
+ name: Deploy Documentation to asf-site Branch
+ runs-on: ubuntu-latest
+
+ steps:
+ # Checkout the repository code
+ - name: Checkout Repository
+ uses: actions/checkout@v4
+ with:
+ fetch-depth: 0
+
+ # Setup Node.js environment
+ - name: Setup Node.js
+ uses: actions/setup-node@v4
+ with:
+ node-version: '20'
+
+ # Install dependencies in home directory
+ - name: Install Dependencies
+ working-directory: home
+ run: npm ci
+
+ # Build the documentation site
+ - name: Build Documentation
+ working-directory: home
+ run: npm run build
+ env:
+ NODE_OPTIONS: --max-old-space-size=4096
+
+ # Deploy to asf-site branch using peaceiris/actions-gh-pages
+ - name: Deploy to asf-site Branch
+ uses: peaceiris/actions-gh-pages@v3
+ with:
+ github_token: ${{ secrets.GITHUB_TOKEN }}
+ publish_dir: ./home/build
+ publish_branch: asf-site
+ force_orphan: true
+ user_name: 'github-actions[bot]'
+ user_email: 'github-actions[bot]@users.noreply.github.com'
+ commit_message: 'Deploy documentation to asf-site branch'
+
+ # Output deployment status
+ - name: Deployment Summary
+ run: |
+ echo "Documentation deployed successfully!"
+ echo "Deployment branch: asf-site"
+ echo "Source branch: ${{ github.ref_name }}"
+ echo "Commit SHA: ${{ github.sha }}"
diff --git a/home/docusaurus.config.js b/home/docusaurus.config.js
index fe9461d294..b3e14d1ac3 100644
--- a/home/docusaurus.config.js
+++ b/home/docusaurus.config.js
@@ -303,10 +303,10 @@ module.exports = {
remarkPlugins: [
[require('@docusaurus/remark-plugin-npm2yarn'), { sync: true }],
],
- lastVersion: '1.7.x',
+ lastVersion: '1.8.0',
versions: {
current: {
- label: 'dev',
+ label: 'current',
},
},
},
diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.8.0.json
b/home/i18n/en/docusaurus-plugin-content-docs/version-1.8.0.json
similarity index 67%
copy from home/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.8.0.json
copy to home/i18n/en/docusaurus-plugin-content-docs/version-1.8.0.json
index 9830d49450..6bca6d9e7b 100644
--- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.8.0.json
+++ b/home/i18n/en/docusaurus-plugin-content-docs/version-1.8.0.json
@@ -1,90 +1,86 @@
{
"version.label": {
- "message": "dev",
+ "message": "1.8.0",
"description": "The label for version current"
},
"sidebar.docs.category.quickstart": {
- "message": "快速开始",
+ "message": "QuickStart",
"description": "The label for category quickstart in sidebar docs"
},
"sidebar.docs.category.custom": {
- "message": "自定义监控",
+ "message": "Custom Monitoring",
"description": "The label for category custom in sidebar docs"
},
"sidebar.docs.category.http": {
- "message": "HTTP协议",
+ "message": "HTTP Protocol",
"description": "The label for category http in sidebar docs"
},
"sidebar.docs.category.jdbc": {
- "message": "JDBC协议",
+ "message": "JDBC Protocol",
"description": "The label for category jdbc in sidebar docs"
},
"sidebar.docs.category.ssh": {
- "message": "SSH协议",
+ "message": "SSH Protocol",
"description": "The label for category ssh in sidebar docs"
},
"sidebar.docs.category.telnet": {
- "message": "TELNET协议",
+ "message": "TELNET Protocol",
"description": "The label for category telnet in sidebar docs"
},
"sidebar.docs.category.guides": {
- "message": "使用指南",
+ "message": "Use Guides",
"description": "The label for category guides in sidebar docs"
},
"sidebar.docs.category.service": {
- "message": "应用服务监控",
+ "message": "Service Monitor",
"description": "The label for category service in sidebar docs"
},
"sidebar.docs.category.database": {
- "message": "数据库监控",
+ "message": "Database Monitor",
"description": "The label for category database in sidebar docs"
},
"sidebar.docs.category.os": {
- "message": "操作系统监控",
+ "message": "OS Monitor",
"description": "The label for category os in sidebar docs"
},
"sidebar.docs.category.server": {
- "message": "服务器监控",
+ "message": "Server Monitor",
"description": "The label for category server in sidebar docs"
},
- "sidebar.docs.category.mid": {
- "message": "中间件监控",
- "description": "The label for category mid in sidebar docs"
- },
"sidebar.docs.category.alert": {
- "message": "阈值告警",
+ "message": "Alerting",
"description": "The label for category alert in sidebar docs"
},
"sidebar.docs.category.notice": {
- "message": "消息通知",
+ "message": "Notification",
"description": "The label for category notice in sidebar docs"
},
"sidebar.docs.category.service-discovery": {
- "message": "服务发现",
+ "message": "Service Discovery",
"description": "The label for category service-discovery in sidebar docs"
},
+ "sidebar.docs.category.mid": {
+ "message": "Middleware Monitor",
+ "description": "The label for category mid in sidebar docs"
+ },
"sidebar.docs.category.Others": {
- "message": "其它",
+ "message": "Others",
"description": "The label for category Others in sidebar docs"
},
"sidebar.docs.category.cloud-native": {
- "message": "云原生监控",
+ "message": "CloudNative Monitor",
"description": "The label for category cloud-native in sidebar docs"
},
- "sidebar.docs.link.Install via HuaweiCloud": {
- "message": "华为云方式部署",
- "description": "The label for link Install via HuaweiCloud in sidebar
docs, linking to
https://marketplace.huaweicloud.com/contents/0477015c-ad63-4522-a308-816861769f0a#productid=OFFI863735781612109824";
- },
"sidebar.docs.category.jmx": {
- "message": "JMX协议",
+ "message": "JMX Protocol",
"description": "The label for category jmx in sidebar docs"
},
"sidebar.docs.category.snmp": {
- "message": "SNMP协议",
+ "message": "SNMP Protocol",
"description": "The label for category snmp in sidebar docs"
},
"sidebar.docs.link.Install via Helm": {
- "message": "Helm方式安装",
+ "message": "Install via Helm",
"description": "The label for link Install via Helm in sidebar docs,
linking to https://artifacthub.io/packages/helm/hertzbeat/hertzbeat";
},
"sidebar.docs.category.push": {
@@ -92,39 +88,39 @@
"description": "The label for category push in sidebar docs"
},
"sidebar.docs.category.program": {
- "message": "应用程序监控",
+ "message": "Program Monitor",
"description": "The label for category program in sidebar docs"
},
"sidebar.docs.category.cache": {
- "message": "缓存监控",
+ "message": "Cache Monitor",
"description": "The label for category cache in sidebar docs"
},
"sidebar.docs.category.bigdata": {
- "message": "大数据监控",
+ "message": "Bigdata Monitor",
"description": "The label for category bigdata in sidebar docs"
},
"sidebar.docs.category.webserver": {
- "message": "Web服务器监控",
+ "message": "WebServer Monitor",
"description": "The label for category webserver in sidebar docs"
},
- "sidebar.docs.category.Community": {
- "message": "社区",
- "description": "The label for category Community in sidebar docs"
- },
"sidebar.docs.category.contribution": {
- "message": "贡献指南",
+ "message": "Contribution Guide",
"description": "The label for category contribution in sidebar docs"
},
"sidebar.docs.category.submit": {
- "message": "提交指南",
+ "message": "Submit Guide",
"description": "The label for category submit in sidebar docs"
},
"sidebar.docs.category.release": {
- "message": "发布指南",
+ "message": "Release Guide",
"description": "The label for category release in sidebar docs"
},
+ "sidebar.docs.category.Community": {
+ "message": "Community",
+ "description": "The label for category Community in sidebar docs"
+ },
"sidebar.docs.category.network": {
- "message": "网络监控",
+ "message": "Network Monitor",
"description": "The label for category network in sidebar docs"
},
"sidebar.docs.category.NGQL": {
@@ -132,55 +128,39 @@
"description": "The label for category NGQL in sidebar docs"
},
"sidebar.docs.category.llm": {
- "message": "AI大模型监控",
+ "message": "AI LLM Monitor",
"description": "The label for category llm in sidebar docs"
},
"sidebar.docs.category.aiConfig": {
- "message": "AI大模型配置",
+ "message": "AI LLM Config",
"description": "The label for category aiConfig in sidebar docs"
},
"sidebar.docs.category.install": {
- "message": "安装",
+ "message": "Install",
"description": "The label for category install in sidebar docs"
},
"sidebar.docs.category.upgrade": {
- "message": "升级",
+ "message": "Upgrade",
"description": "The label for category upgrade in sidebar docs"
},
"sidebar.docs.category.setting": {
- "message": "配置",
+ "message": "Setting",
"description": "The label for category setting in sidebar docs"
},
"sidebar.docs.category.change-db": {
- "message": "数据库切换",
+ "message": "Change DB",
"description": "The label for category change-db in sidebar docs"
},
"sidebar.docs.category.use-case": {
- "message": "使用案例",
+ "message": "Use Case",
"description": "The label for category use-case in sidebar docs"
},
"sidebar.docs.category.extern-deploy": {
- "message": "集成平台部署",
+ "message": "Extern Install",
"description": "The label for category extern-deploy in sidebar docs"
},
- "sidebar.docs.category.quickstart-use-case": {
- "message": "使用案例",
- "description": "The label for category quickstart-use-case in sidebar docs"
- },
- "sidebar.docs.category.guides-use-case": {
- "message": "使用案例",
- "description": "The label for category guides-use-case in sidebar docs"
- },
- "sidebar.docs.category.help-custom": {
- "message": "自定义监控",
- "description": "The label for category help-custom in sidebar docs"
- },
- "sidebar.docs.category.advanced-custom": {
- "message": "自定义监控",
- "description": "The label for category advanced-custom in sidebar docs"
- },
"sidebar.docs.category.log": {
- "message": "日志监控 (Beta)",
+ "message": "Log",
"description": "The label for category log in sidebar docs"
}
}
diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.8.0.json
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.8.0.json
index 9830d49450..7c60abc6ac 100644
--- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.8.0.json
+++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.8.0.json
@@ -1,6 +1,6 @@
{
"version.label": {
- "message": "dev",
+ "message": "1.8.0",
"description": "The label for version current"
},
"sidebar.docs.category.quickstart": {
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
