This is an automated email from the ASF dual-hosted git repository.
zhongjiajie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/dolphinscheduler-website.git
The following commit(s) were added to refs/heads/master by this push:
new 123d510 Proofreading dev documents under /user_doc/guide/alert (#719)
123d510 is described below
commit 123d5108200a08e59c18a80b74fcce2a07cff523
Author: Tq <[email protected]>
AuthorDate: Wed Mar 9 11:27:33 2022 +0800
Proofreading dev documents under /user_doc/guide/alert (#719)
---
.../user_doc/guide/alert/alert_plugin_user_guide.md | 6 +++---
docs/en-us/dev/user_doc/guide/alert/dingtalk.md | 9 +++++----
.../dev/user_doc/guide/alert/enterprise-webexteams.md | 11 ++++++-----
.../dev/user_doc/guide/alert/enterprise-wechat.md | 9 +++++----
docs/en-us/dev/user_doc/guide/alert/telegram.md | 19 +++++++++----------
docs/zh-cn/dev/user_doc/guide/alert/telegram.md | 2 ++
6 files changed, 30 insertions(+), 26 deletions(-)
diff --git a/docs/en-us/dev/user_doc/guide/alert/alert_plugin_user_guide.md
b/docs/en-us/dev/user_doc/guide/alert/alert_plugin_user_guide.md
index 83db24d..8ea72f8 100644
--- a/docs/en-us/dev/user_doc/guide/alert/alert_plugin_user_guide.md
+++ b/docs/en-us/dev/user_doc/guide/alert/alert_plugin_user_guide.md
@@ -2,11 +2,11 @@
## How to Create Alert Plugins and Alert Groups
-In version 2.0.0, users need to create alert instances, and then associate
them with alert groups, and an alert group can use multiple alert instances,
and we will notify them one by one.
+In version 2.0.0, users need to create alert instances, and then associate
them with alert groups. Alert group can use multiple alert instances and notify
them one by one.
-First of all, you need to go to the Security Center, select Alarm Group
Management, then click Alarm Instance Management on the left, then create an
alarm instance, then select the corresponding alarm plug-in and fill in the
relevant alarm parameters.
+First, go to the Security Center page. Select Alarm Group Management, click
Alarm Instance Management on the left and create an alarm instance. Select the
corresponding alarm plug-in and fill in the relevant alarm parameters.
-Then select Alarm Group Management, create an alarm group, and select the
corresponding alarm instance.
+Then select Alarm Group Management, create an alarm group, and choose the
corresponding alarm instance.
<img src="/img/alert/alert_step_1.png">
<img src="/img/alert/alert_step_2.png">
diff --git a/docs/en-us/dev/user_doc/guide/alert/dingtalk.md
b/docs/en-us/dev/user_doc/guide/alert/dingtalk.md
index 9944973..d65e906 100644
--- a/docs/en-us/dev/user_doc/guide/alert/dingtalk.md
+++ b/docs/en-us/dev/user_doc/guide/alert/dingtalk.md
@@ -1,6 +1,7 @@
# DingTalk
-If you need to use DingTalk for alerting, please create an alert instance in
the alert instance management and select the DingTalk plugin. The configuration
example of DingTalk is as follows:
+If you need to use `DingTalk` for alerting, create an alert instance in the
alert instance management and select the DingTalk plugin.
+The `DingTalk` example configuration is as follows:
@@ -15,12 +16,12 @@ If you need to use DingTalk for alerting, please create an
alert instance in the
* MessageType
> Support both text and markdown types
-When a custom bot sends a message, you can specify the "@person list" by your
mobile phone number. When the people in the "@people list" receive the message,
there will be a @ message reminder. Do not disturb conversations still notify
reminders, and "someone @ you" appears on the fold
+When a custom bot sends a message, you can specify the "@person list" by their
mobile phone number. When the selected people in the "@people list" receive the
message, there will be a `@` message reminder. `No disturb` mode always
receives reminders, and "someone @ you" appears in the message.
* @Mobiles
> The mobile phone number of the "@person"
* @UserIds
- > The userid by "@person"
+ > The user ID by "@person"
* @All
- > Is @Everyone
+ > @Everyone
[DingTalk Custom Robot Access Development
Documentation](https://open.dingtalk.com/document/robots/custom-robot-access)
diff --git a/docs/en-us/dev/user_doc/guide/alert/enterprise-webexteams.md
b/docs/en-us/dev/user_doc/guide/alert/enterprise-webexteams.md
index f731f99..f28de0d 100644
--- a/docs/en-us/dev/user_doc/guide/alert/enterprise-webexteams.md
+++ b/docs/en-us/dev/user_doc/guide/alert/enterprise-webexteams.md
@@ -1,23 +1,24 @@
# Webex Teams
-If you need to use Webex Teams to alert, please create an alarm Instance in
warning instance manage, and then choose the WebexTeams plugin. The
configuration example of enterprise WebexTeams is as follows:
+If you need to use `Webex Teams` to alert, create an alert instance in the
alert instance management, and choose the WebexTeams plugin.
+The `WebexTeams` example configuration is as follows:
## Parameter Configuration
* botAccessToken
- > The robot's access token you were given
+ > The robot's access token
* roomID
- > The room ID of the message
+ > The ID of the room that receives message (only support one room ID)
* toPersonId
> The person ID of the recipient when sending a private 1:1 message
* toPersonEmail
> The email address of the recipient when sending a private 1:1 message
* atSomeoneInRoom
- > If the message destination is room, the user emails of the person being @,
use ,(eng commas) to separate multiple emails
+ > If the message destination is room, the emails of the person being @, use
`,` (eng commas) to separate multiple emails
* destination
- > Provide only one message destination in the roomId, toPersonEmail, or
toPersonId field
+ > The destination of the message (one message only support one destination)
[WebexTeams Application Bot Guide](https://developer.webex.com/docs/bots)
[WebexTeams Message
Guide](https://developer.webex.com/docs/api/v1/messages/create-a-message)
diff --git a/docs/en-us/dev/user_doc/guide/alert/enterprise-wechat.md
b/docs/en-us/dev/user_doc/guide/alert/enterprise-wechat.md
index f9578a6..0b7756d 100644
--- a/docs/en-us/dev/user_doc/guide/alert/enterprise-wechat.md
+++ b/docs/en-us/dev/user_doc/guide/alert/enterprise-wechat.md
@@ -1,13 +1,14 @@
# Enterprise WeChat
-If you need to use Enterprise WeChat to alert, please create an alarm Instance
in warning instance manage, and then choose the wechat plugin. The
configuration example of enterprise WeChat is as follows
+If you need to use `Enterprise WeChat` to alert, create an alert instance in
the alert instance management, and choose the WeChat plugin.
+The `WeChat` example configuration is as follows:
-Where send type corresponds to app and appchat respectively:
+The parameter `send.type` corresponds to app and group chat respectively:
APP: https://work.weixin.qq.com/api/doc/90000/90135/90236
-APPCHAT: https://work.weixin.qq.com/api/doc/90000/90135/90248
+Group Chat: https://work.weixin.qq.com/api/doc/90000/90135/90248
-user.send.msg corresponds to the content in the document. The variable of the
corresponding value is {msg}
\ No newline at end of file
+The parameter `user.send.msg` corresponds to the `content` in the document,
and the corresponding variable is `{msg}`.
\ No newline at end of file
diff --git a/docs/en-us/dev/user_doc/guide/alert/telegram.md
b/docs/en-us/dev/user_doc/guide/alert/telegram.md
index d0d7f7b..89dbccf 100644
--- a/docs/en-us/dev/user_doc/guide/alert/telegram.md
+++ b/docs/en-us/dev/user_doc/guide/alert/telegram.md
@@ -1,31 +1,30 @@
# Telegram
-If you need `Telegram` to alert, please create an alarm instance in warning
instance manage dashboard. and choose the `Telegram` plugin
-
-The configuration example of `Telegram` is as follows:
+If you need `Telegram` to alert, create an alert instance in the alert
instance management, and choose the `Telegram` plugin.
+The `Telegram` example configuration is as follows:
## Parameter Configuration
* WebHook:
- > Telegram open api
+ > The WebHook of Telegram when use robot to send message
* botToken
- > The robot's access token you were given
+ > The robot's access token
* chatId
> Sub Telegram Channel
* parseMode
- > Mode for parsing entities in the message
text.(txt、markdown、markdownV2、html)
+ > Message parse type (support txt, markdown, markdownV2, html)
* EnableProxy
- > Enable Proxy Sever.
+ > Enable proxy sever
* Proxy
- > the proxy address of Proxy-Server
+ > the proxy address of the proxy server
* Port
> the proxy port of Proxy-Server
* User
- > Authentication(Username) for Proxy-Server
+ > Authentication(Username) for the proxy server
* Password
- > Authentication(Password) for Proxy-Server
+ > Authentication(Password) for the proxy server
References:
- [Telegram Application Bot Guide](https://core.telegram.org/bots)
diff --git a/docs/zh-cn/dev/user_doc/guide/alert/telegram.md
b/docs/zh-cn/dev/user_doc/guide/alert/telegram.md
index fb91d99..c631915 100644
--- a/docs/zh-cn/dev/user_doc/guide/alert/telegram.md
+++ b/docs/zh-cn/dev/user_doc/guide/alert/telegram.md
@@ -19,6 +19,8 @@
> 开启代理
* Proxy
> 代理地址
+* Port
+ > 代理端口
* User
> 代理鉴权用户
* Password
