Skip to content

Commit

Permalink
[doc] Bulletin doc (apache#2631)
Browse files Browse the repository at this point in the history
  • Loading branch information
zqr10159 authored Aug 29, 2024
1 parent 6074c08 commit 24678c2
Show file tree
Hide file tree
Showing 8 changed files with 63 additions and 6 deletions.
28 changes: 28 additions & 0 deletions home/docs/help/bulletin.md
Original file line number Diff line number Diff line change
@@ -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.

![new-bulletin](/img/docs/help/bulletin-1.png)

### 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.

![bulletin](/img/docs/help/bulletin-2.png)
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
id: bulletin
title: 自定义看板
sidebar_label: 自定义看板
keywords: [看板, 自定义]
---

> 自定义监控看板,以表格形式展示某种监控的自选指标。
### 新增看板项

1. 点击新增看板项, 输入`看板名称`, 下拉选择`监控类型`, 再选择关联的`监控任务名称`, 最后在穿梭框中选择需要展示的`监控指标`

2. 点击`确定`按钮, 即可完成自定义看板的创建。

![new-bulletin](/img/docs/help/bulletin-1.png)

### 查看多个看板

1. 点击标签页中的看板名称, 即可查看该看板的详细信息。

### 删除看板项

1. 点击`删除看板项`按钮, 即可删除当前看板项。

2. 点击`批量删除看板项`按钮, 即可选择批量删除选中的看板项。

![bulletin](/img/docs/help/bulletin-2.png)
5 changes: 3 additions & 2 deletions home/sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -356,9 +356,10 @@
"help/alert_smn"
]
},
"help/issue",
"help/bulletin",
"help/plugin",
"help/time_expression"
"help/time_expression",
"help/issue"
]
},
{
Expand Down
Binary file added home/static/img/docs/help/bulletin-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added home/static/img/docs/help/bulletin-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions web-app/src/assets/i18n/en-US.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,15 +48,15 @@
"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",
"monitor.name": "Monitor Task Name",
"monitor.metrics": "Monitor Metrics",
"help.message.content": "Custom Monitoring Bulletin",
"help.content": "Custom monitoring bulletin, displaying selected metrics of a specific monitor in table form",
"help.link": ""
"help.link": "https://hertzbeat.apache.org/docs/help/bulletin"
},
"advanced": {
"": "Advanced",
Expand Down
2 changes: 1 addition & 1 deletion web-app/src/assets/i18n/zh-CN.json
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@
"monitor.metrics": "监控指标",
"help.message.content": "自定义监控看板",
"help.content": "自定义监控看板,以表格形式展示某种监控的自选指标",
"help.link": ""
"help.link": "https://hertzbeat.apache.org/zh-cn/docs/help/bulletin"
},
"question.link": "https://hertzbeat.apache.org/zh-cn/docs/help/issue",
"alert.setting.new": "新增阈值规则",
Expand Down
2 changes: 1 addition & 1 deletion web-app/src/assets/i18n/zh-TW.json
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@
"monitor.metrics": "監控指標",
"help.message.content": "自定義監控看板",
"help.content": "自定義監控看板,以表格形式展示某種監控的自選指標",
"help.link": ""
"help.link": "https://hertzbeat.apache.org/docs/help/bulletin"
},
"alert.setting.new": "新增阈值規則",
"alert.setting.edit": "編輯阈值規則",
Expand Down

0 comments on commit 24678c2

Please sign in to comment.