You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dolphinscheduler.apache.org by zh...@apache.org on 2022/03/31 01:32:23 UTC
[dolphinscheduler-website] branch master updated: [FIX] [WEBSITE-9275]fix both en and cn webex doc (#752)
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 d40ac62 [FIX] [WEBSITE-9275]fix both en and cn webex doc (#752)
d40ac62 is described below
commit d40ac62267f79f17ef548fd334eae91b8b505cb8
Author: Tq <ti...@gmail.com>
AuthorDate: Thu Mar 31 09:32:17 2022 +0800
[FIX] [WEBSITE-9275]fix both en and cn webex doc (#752)
---
.../user_doc/guide/alert/enterprise-webexteams.md | 40 ++++++++++++++++++
.../user_doc/guide/alert/enterprise-webexteams.md | 45 ++++++++++++++++++++-
img/alert/enterprise-webexteams-bot.png | Bin 0 -> 41301 bytes
img/alert/enterprise-webexteams-group-form.png | Bin 0 -> 27108 bytes
img/alert/enterprise-webexteams-private-form.png | Bin 0 -> 25984 bytes
img/alert/enterprise-webexteams-private-msg.png | Bin 0 -> 36098 bytes
img/alert/enterprise-webexteams-room-msg.png | Bin 0 -> 36011 bytes
img/alert/enterprise-webexteams-room.png | Bin 0 -> 118445 bytes
8 files changed, 83 insertions(+), 2 deletions(-)
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 5acb0b1..19819cd 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,6 +1,7 @@
# Webex Teams
If you need to use `Webex Teams` to alert, create an alert instance in the alert instance management, and choose the WebexTeams plugin.
+You can pick private alert or room group chat alert.
The following is the `WebexTeams` configuration example:
@@ -20,5 +21,44 @@ The following is the `WebexTeams` configuration example:
* destination
> The destination of the message (one message only support one destination)
+## Create a Bot
+
+Create a bot visit [Official Website My-Apps](https://developer.webex.com/my-apps) to `Create a New APP` and select `Create a Bot`, fill in the bot information and acquire `bot username` and `bot ID` for further usage.
+
+
+
+## Create a Room
+
+Create a root visit [Official Website for Developer APIs](https://developer.webex.com/docs/api/v1/rooms/create-a-room) to create a new room, fill in the room name and acquire `id`(room ID) and `creatorId` for further usage.
+
+
+
+### Invite Bot to the Room
+
+Invite bot to the room by invite bot Email (bot username).
+
+## Send Private Message
+
+In this way, you can send private message to a person by `User Email` or `UserId` in a private conversation. Fill in the `To Person Id` or `To Person Email`(recommended) and `Bot Access Token` and select `Destination` `personEmail` or `personId`.
+The `user Email` is user register Email.
+The `userId` we can acquire it from the `creatorId` of creating a new group chat room API.
+
+
+
+### Private Alert Message Example
+
+
+
+## Send Group Room Message
+
+In this way, you can send group room message to a room by `Room ID`. Fill in the `Room Id` and `Bot Access Token` and select `Destination` `roomId`.
+The `Room ID` we can acquire it from the `id` of creating a new group chat room API.
+
+
+
+### Group Room Alert Message Example
+
+
+
[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/zh-cn/dev/user_doc/guide/alert/enterprise-webexteams.md b/docs/zh-cn/dev/user_doc/guide/alert/enterprise-webexteams.md
index 4f82bcc..58e38d8 100644
--- a/docs/zh-cn/dev/user_doc/guide/alert/enterprise-webexteams.md
+++ b/docs/zh-cn/dev/user_doc/guide/alert/enterprise-webexteams.md
@@ -1,10 +1,12 @@
# WebexTeams
-如果您需要使用到Webex Teams进行告警，请在告警实例管理里创建告警实例，选择 WebexTeams 插件。WebexTeams的配置样例如下:
+如果您需要使用到Webex Teams进行告警，请在告警实例管理里创建告警实例，选择 WebexTeams 插件。
+你可以选择机器人私聊通知或聊天室通知。
+WebexTeams的配置样例如下:
-参数配置
+## 参数配置
* botAccessToken
> 在创建机器人时，获得的访问令牌
@@ -19,6 +21,45 @@
* destination
> 消息目的地，一条消息只支持一个目的地
+## 创建一个机器人
+
+访问[官网My-Apps](https://developer.webex.com/docs/api/v1/rooms/create-a-room)来创建一个机器人，点击`Create a New APP` 然后选择 `Create a Bot`，填入机器人信息后获取`bot username` 和 `bot ID`以备以下步骤使用。
+
+
+
+## 创建一个房间
+
+访问[官网开发者APIs](https://developer.webex.com/docs/api/v1/rooms/create-a-room)来创建一个房间，填入房间名称后获取`id`(room ID) 和 `creatorId`以备以下步骤使用。
+
+
+
+### 邀请机器人到房间
+
+通过机器人的Email(bot username)将机器人添加至房间。
+
+## 发送私聊消息
+
+通过这种方式，你可以通过`用户邮箱`或`用户`对一个用户私聊窗口发送告警，填入`用户` 或 `用户邮箱`(推荐) 和 `访问令牌`并选择`描述` `personEmail` 或 `personId`。
+`用户邮箱`是用户注册Email地址。
+`用户`我们可以从新建房间返回的`creatorId`中获取。
+
+
+
+### 私聊告警样例
+
+
+
+## 发送群聊消息
+
+通过这种方式，你可以通过`房间`向一个房间发送告警，填入`房间` 和 `访问令牌`并选择`描述` `roomId`。
+`房间`我们可以从新建房间API返回的`id`中获取。
+
+
+
+### 群聊告警消息样例
+
+
+
[WebexTeams申请机器人文档](https://developer.webex.com/docs/bots)
[WebexTeamsMessage开发文档](https://developer.webex.com/docs/api/v1/messages/create-a-message)
diff --git a/img/alert/enterprise-webexteams-bot.png b/img/alert/enterprise-webexteams-bot.png
new file mode 100644
index 0000000..76cee39
Binary files /dev/null and b/img/alert/enterprise-webexteams-bot.png differ
diff --git a/img/alert/enterprise-webexteams-group-form.png b/img/alert/enterprise-webexteams-group-form.png
new file mode 100644
index 0000000..25f70f8
Binary files /dev/null and b/img/alert/enterprise-webexteams-group-form.png differ
diff --git a/img/alert/enterprise-webexteams-private-form.png b/img/alert/enterprise-webexteams-private-form.png
new file mode 100644
index 0000000..54824a2
Binary files /dev/null and b/img/alert/enterprise-webexteams-private-form.png differ
diff --git a/img/alert/enterprise-webexteams-private-msg.png b/img/alert/enterprise-webexteams-private-msg.png
new file mode 100644
index 0000000..abebfff
Binary files /dev/null and b/img/alert/enterprise-webexteams-private-msg.png differ
diff --git a/img/alert/enterprise-webexteams-room-msg.png b/img/alert/enterprise-webexteams-room-msg.png
new file mode 100644
index 0000000..1c999fd
Binary files /dev/null and b/img/alert/enterprise-webexteams-room-msg.png differ
diff --git a/img/alert/enterprise-webexteams-room.png b/img/alert/enterprise-webexteams-room.png
new file mode 100644
index 0000000..26835f3
Binary files /dev/null and b/img/alert/enterprise-webexteams-room.png differ