This is an automated email from the ASF dual-hosted git repository. zhaoqingran pushed a commit to branch bulletin-doc in repository https://gitbox.apache.org/repos/asf/hertzbeat.git
commit 66eaab3ff4c9e46601a19d85a962cf024a919d26 Author: zqr10159 <[email protected]> AuthorDate: Thu Aug 29 09:53:13 2024 +0800 ```docs: update bulletin help documentation and i18n strings - Add documentation for customized bulletins in both English and Chinese. - Include screenshots for visual guidance in the bulletin documentation. - Modify pluralization in 'Batch delete Bulletin Items' i18n string for consistency. - Ensure all commit messages adhere to the specified format and guidelines. ``` --- home/docs/help/bulletin.md | 28 +++++++++++++++++++++ .../current/help/bulletin.md | 28 +++++++++++++++++++++ home/static/img/docs/help/bulletin-1.png | Bin 0 -> 79792 bytes home/static/img/docs/help/bulletin-2.png | Bin 0 -> 31781 bytes home/static/img/docs/help/img_1.png | Bin 0 -> 33032 bytes web-app/src/assets/i18n/en-US.json | 2 +- 6 files changed, 57 insertions(+), 1 deletion(-) diff --git a/home/docs/help/bulletin.md b/home/docs/help/bulletin.md new file mode 100644 index 000000000..0535df416 --- /dev/null +++ b/home/docs/help/bulletin.md @@ -0,0 +1,28 @@ +--- +id: bulletin +title: Customizable bulletins +sidebar_label: Customized bulletins +keywords: [bulletin, custom] +--- + +> Customize a bulletin to show a table of self-selected metrics for some kind of monitoring. + +### Add Bulletin Item + +1. Click `Add New Bulletin Item`, enter the `Bulletin Name`, scroll down to select the `Monitoring Type`, select the associated `Monitoring Task Name`, and then select the `Monitoring Metrics` you want to show in the shuttle box. + +2. Click `OK` button to finish creating the customized bulletin. + +  + +### Viewing Multiple Bulletins + +1. Click the name of the bulletin in the tab to view the details of that bulletin. + +### Deleting Bulletins + +1. Click the `Delete Bulletin Item` button to delete the current bulletin. 2. + +2. Click the `Batch delete Bulletin Items` button to delete selected bulletins in a batch. + +  \ No newline at end of file diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/bulletin.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/bulletin.md new file mode 100644 index 000000000..6624dc33d --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/bulletin.md @@ -0,0 +1,28 @@ +--- +id: bulletin +title: 自定义看板 +sidebar_label: 自定义看板 +keywords: [看板, 自定义] +--- + +> 自定义监控看板,以表格形式展示某种监控的自选指标。 + +### 新增看板项 + +1. 点击新增看板项, 输入`看板名称`, 下拉选择`监控类型`, 再选择关联的`监控任务名称`, 最后在穿梭框中选择需要展示的`监控指标`。 + +2. 点击`确定`按钮, 即可完成自定义看板的创建。 + +  + +### 查看多个看板 + +1. 点击标签页中的看板名称, 即可查看该看板的详细信息。 + +### 删除看板项 + +1. 点击`删除看板项`按钮, 即可删除当前看板项。 + +2. 点击`批量删除看板项`按钮, 即可选择批量删除选中的看板项。 + +  \ No newline at end of file diff --git a/home/static/img/docs/help/bulletin-1.png b/home/static/img/docs/help/bulletin-1.png new file mode 100644 index 000000000..ae6582312 Binary files /dev/null and b/home/static/img/docs/help/bulletin-1.png differ diff --git a/home/static/img/docs/help/bulletin-2.png b/home/static/img/docs/help/bulletin-2.png new file mode 100644 index 000000000..d0af9502a Binary files /dev/null and b/home/static/img/docs/help/bulletin-2.png differ diff --git a/home/static/img/docs/help/img_1.png b/home/static/img/docs/help/img_1.png new file mode 100644 index 000000000..7265ebb06 Binary files /dev/null and b/home/static/img/docs/help/img_1.png differ diff --git a/web-app/src/assets/i18n/en-US.json b/web-app/src/assets/i18n/en-US.json index d73581fa6..01be7ba32 100644 --- a/web-app/src/assets/i18n/en-US.json +++ b/web-app/src/assets/i18n/en-US.json @@ -48,7 +48,7 @@ "new": "Add New Bulletin Item", "edit": "Edit Bulletin Item", "delete": "Delete Bulletin Item", - "batch.delete": "Batch delete Bulletin Item", + "batch.delete": "Batch delete Bulletin Items", "name": "Bulletin Name", "name.placeholder": "Please enter a custom bulletin name", "monitor.type": "Monitor Type", --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
