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 9da4355 [Feature-8245][Alert] add telegram alter plugin doc. (#666)
9da4355 is described below
commit 9da435518991adce39d4cc7f3755c18e13d92f78
Author: pinkhello <[email protected]>
AuthorDate: Mon Feb 7 11:08:14 2022 +0800
[Feature-8245][Alert] add telegram alter plugin doc. (#666)
Co-authored-by: Jiajie Zhong <[email protected]>
---
docs/en-us/dev/user_doc/guide/alert/telegram.md | 33 ++++++++++++++++++++++++
docs/zh-cn/dev/user_doc/guide/alert/telegram.md | 31 ++++++++++++++++++++++
img/alert/telegram-plugin.png | Bin 0 -> 74412 bytes
3 files changed, 64 insertions(+)
diff --git a/docs/en-us/dev/user_doc/guide/alert/telegram.md
b/docs/en-us/dev/user_doc/guide/alert/telegram.md
new file mode 100644
index 0000000..c5dc231
--- /dev/null
+++ b/docs/en-us/dev/user_doc/guide/alert/telegram.md
@@ -0,0 +1,33 @@
+# 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:
+
+
+
+params config:
+
+* WebHook:
+ > Telegram open api
+* botToken
+ > The robot's access token you were given
+* chatId
+ > Sub Telegram Channel
+* parseMode
+ > Mode for parsing entities in the message
text.(txt、markdown、markdownV2、html)
+* EnableProxy
+ > Enable Proxy Sever.
+* Proxy
+ > the proxy address of Proxy-Server
+* Port
+ > the proxy port of Proxy-Server
+* User
+ > Authentication(Username) for Proxy-Server
+* Password
+ > Authentication(Password) for Proxy-Server
+
+P.S.:
+- [Telegram Application Bot Guide](https://core.telegram.org/bots)
+- [Telegram Bots Api](https://core.telegram.org/bots/api)
+- [Telegram SendMessage Api](https://core.telegram.org/bots/api#sendmessage)
+
diff --git a/docs/zh-cn/dev/user_doc/guide/alert/telegram.md
b/docs/zh-cn/dev/user_doc/guide/alert/telegram.md
new file mode 100644
index 0000000..fb91d99
--- /dev/null
+++ b/docs/zh-cn/dev/user_doc/guide/alert/telegram.md
@@ -0,0 +1,31 @@
+# Telegram
+
+如果您需要使用`Telegram`进行告警，请在告警实例管理模块创建告警实例，选择`Telegram`插件。
+
+`Telegram`的配置样例如下:
+
+
+
+参数配置:
+* WebHook:
+ > 使用 Telegram 的机器人，发送消息的WebHook。
+* botToken
+ > 创建 Telegram 的机器人，获取的访问令牌。
+* chatId
+ > 订阅的 Telegram 频道
+* parseMode
+ > 消息解析类型, 支持: txt、markdown、markdownV2、html
+* EnableProxy
+ > 开启代理
+* Proxy
+ > 代理地址
+* User
+ > 代理鉴权用户
+* Password
+ > 代理鉴权密码
+
+
+[Telegram 如何申请机器人，如何创建频道](https://core.telegram.org/bots)
+[Telegram 机器人开发文档](https://core.telegram.org/bots/api)
+[Telegram SendMessage 接口文档](https://core.telegram.org/bots/api#sendmessage)
+
diff --git a/img/alert/telegram-plugin.png b/img/alert/telegram-plugin.png
new file mode 100644
index 0000000..6e2429c
Binary files /dev/null and b/img/alert/telegram-plugin.png differ
