You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dolphinscheduler.apache.org by gi...@apache.org on 2022/03/31 01:35:42 UTC
[dolphinscheduler-website] branch asf-site updated: Automated deployment: d40ac62267f79f17ef548fd334eae91b8b505cb8
This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/dolphinscheduler-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new af3da6c Automated deployment: d40ac62267f79f17ef548fd334eae91b8b505cb8
af3da6c is described below
commit af3da6c4e347c59322b07829cda7b4ccdcdace98
Author: github-actions[bot] <gi...@users.noreply.github.com>
AuthorDate: Thu Mar 31 01:35:39 2022 +0000
Automated deployment: d40ac62267f79f17ef548fd334eae91b8b505cb8
---
.../guide/alert/enterprise-webexteams.html | 22 +++++++
.../guide/alert/enterprise-webexteams.json | 2 +-
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
python/.buildinfo | 2 +-
python/_static/doctools.js | 72 +++++++++++++++------
python/_static/documentation_options.js | 4 +-
python/_static/searchtools.js | 8 +--
python/searchindex.js | 2 +-
.../guide/alert/enterprise-webexteams.html | 27 +++++++-
.../guide/alert/enterprise-webexteams.json | 2 +-
15 files changed, 108 insertions(+), 33 deletions(-)
diff --git a/en-us/docs/dev/user_doc/guide/alert/enterprise-webexteams.html b/en-us/docs/dev/user_doc/guide/alert/enterprise-webexteams.html
index d816057..b431203 100644
--- a/en-us/docs/dev/user_doc/guide/alert/enterprise-webexteams.html
+++ b/en-us/docs/dev/user_doc/guide/alert/enterprise-webexteams.html
@@ -12,6 +12,7 @@
<body>
<div id="root"><div class="md2html docs-page" data-reactroot=""><header class="header-container header-container-dark"><div class="header-body"><span class="mobile-menu-btn mobile-menu-btn-dark"></span><a href="/en-us/index.html"><img class="logo" src="/img/hlogo_white.svg"/></a><div class="search search-dark"><span class="icon-search"></span></div><span class="language-switch language-switch-dark">中</span><div class="header-menu"><div><ul class="ant-menu whiteClass ant-menu-light ant- [...]
<p>If you need to use <code>Webex Teams</code> 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 <code>WebexTeams</code> configuration example:</p>
<p><img src="/img/alert/enterprise-webexteams-plugin.png" alt="enterprise-webexteams-plugin"></p>
<h2>Parameter Configuration</h2>
@@ -47,6 +48,27 @@ The following is the <code>WebexTeams</code> configuration example:</p>
</blockquote>
</li>
</ul>
+<h2>Create a Bot</h2>
+<p>Create a bot visit <a href="https://developer.webex.com/my-apps">Official Website My-Apps</a> to <code>Create a New APP</code> and select <code>Create a Bot</code>, fill in the bot information and acquire <code>bot username</code> and <code>bot ID</code> for further usage.</p>
+<p><img src="/img/alert/enterprise-webexteams-bot.png" alt="enterprise-webexteams-bot-info"></p>
+<h2>Create a Room</h2>
+<p>Create a root visit <a href="https://developer.webex.com/docs/api/v1/rooms/create-a-room">Official Website for Developer APIs</a> to create a new room, fill in the room name and acquire <code>id</code>(room ID) and <code>creatorId</code> for further usage.</p>
+<p><img src="/img/alert/enterprise-webexteams-room.png" alt="enterprise-webexteams-room-info"></p>
+<h3>Invite Bot to the Room</h3>
+<p>Invite bot to the room by invite bot Email (bot username).</p>
+<h2>Send Private Message</h2>
+<p>In this way, you can send private message to a person by <code>User Email</code> or <code>UserId</code> in a private conversation. Fill in the <code>To Person Id</code> or <code>To Person Email</code>(recommended) and <code>Bot Access Token</code> and select <code>Destination</code> <code>personEmail</code> or <code>personId</code>.
+The <code>user Email</code> is user register Email.
+The <code>userId</code> we can acquire it from the <code>creatorId</code> of creating a new group chat room API.</p>
+<p><img src="/img/alert/enterprise-webexteams-private-form.png" alt="enterprise-webexteams-private-message-form"></p>
+<h3>Private Alert Message Example</h3>
+<p><img src="/img/alert/enterprise-webexteams-private-msg.png" alt="enterprise-webexteams-private-message-example"></p>
+<h2>Send Group Room Message</h2>
+<p>In this way, you can send group room message to a room by <code>Room ID</code>. Fill in the <code>Room Id</code> and <code>Bot Access Token</code> and select <code>Destination</code> <code>roomId</code>.
+The <code>Room ID</code> we can acquire it from the <code>id</code> of creating a new group chat room API.</p>
+<p><img src="/img/alert/enterprise-webexteams-group-form.png" alt="enterprise-webexteams-room"></p>
+<h3>Group Room Alert Message Example</h3>
+<p><img src="/img/alert/enterprise-webexteams-room-msg.png" alt="enterprise-webexteams-room-message-example"></p>
<p><a href="https://developer.webex.com/docs/bots">WebexTeams Application Bot Guide</a>
<a href="https://developer.webex.com/docs/api/v1/messages/create-a-message">WebexTeams Message Guide</a></p>
</div></section><footer class="footer-container"><div class="footer-body"><div><h3>About us</h3><h4>Do you need feedback? Please contact us through the following ways.</h4></div><div class="contact-container"><ul><li><a href="/en-us/community/development/subscribe.html"><img class="img-base" src="/img/emailgray.png"/><img class="img-change" src="/img/emailblue.png"/><p>Email List</p></a></li><li><a href="https://twitter.com/dolphinschedule"><img class="img-base" src="/img/twittergray.png [...]
diff --git a/en-us/docs/dev/user_doc/guide/alert/enterprise-webexteams.json b/en-us/docs/dev/user_doc/guide/alert/enterprise-webexteams.json
index 8cac36c..f3cc981 100644
--- a/en-us/docs/dev/user_doc/guide/alert/enterprise-webexteams.json
+++ b/en-us/docs/dev/user_doc/guide/alert/enterprise-webexteams.json
@@ -1,6 +1,6 @@
{
"filename": "enterprise-webexteams.md",
- "__html": "<h1>Webex Teams</h1>\n<p>If you need to use <code>Webex Teams</code> to alert, create an alert instance in the alert instance management, and choose the WebexTeams plugin.\nThe following is the <code>WebexTeams</code> configuration example:</p>\n<p><img src=\"/img/alert/enterprise-webexteams-plugin.png\" alt=\"enterprise-webexteams-plugin\"></p>\n<h2>Parameter Configuration</h2>\n<ul>\n<li>botAccessToken\n<blockquote>\n<p>The robot's access token</p>\n</blockquote>\n</li>\n< [...]
+ "__html": "<h1>Webex Teams</h1>\n<p>If you need to use <code>Webex Teams</code> to alert, create an alert instance in the alert instance management, and choose the WebexTeams plugin.\nYou can pick private alert or room group chat alert.\nThe following is the <code>WebexTeams</code> configuration example:</p>\n<p><img src=\"/img/alert/enterprise-webexteams-plugin.png\" alt=\"enterprise-webexteams-plugin\"></p>\n<h2>Parameter Configuration</h2>\n<ul>\n<li>botAccessToken\n<blockquote>\n<p [...]
"link": "/dist/en-us/docs/dev/user_doc/guide/alert/enterprise-webexteams.html",
"meta": {}
}
\ No newline at end of file
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
diff --git a/python/.buildinfo b/python/.buildinfo
index fe85f7d..cc3bd4b 100644
--- a/python/.buildinfo
+++ b/python/.buildinfo
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 8d0ef9d91765d3dc83e5d7e627dd3d60
+config: 5e2f5a06ea58269bbc2247a133216d19
tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/python/_static/doctools.js b/python/_static/doctools.js
index e509e48..e1bfd70 100644
--- a/python/_static/doctools.js
+++ b/python/_static/doctools.js
@@ -154,9 +154,7 @@ var Documentation = {
this.fixFirefoxAnchorBug();
this.highlightSearchWords();
this.initIndexTable();
- if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {
- this.initOnKeyListeners();
- }
+ this.initOnKeyListeners();
},
/**
@@ -269,6 +267,13 @@ var Documentation = {
window.history.replaceState({}, '', url);
},
+ /**
+ * helper function to focus on search bar
+ */
+ focusSearchBar : function() {
+ $('input[name=q]').first().focus();
+ },
+
/**
* make the url absolute
*/
@@ -291,27 +296,54 @@ var Documentation = {
},
initOnKeyListeners: function() {
+ // only install a listener if it is really needed
+ if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
+ !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS)
+ return;
+
$(document).keydown(function(event) {
var activeElementType = document.activeElement.tagName;
// don't navigate when in search box, textarea, dropdown or button
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
- && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey
- && !event.shiftKey) {
- switch (event.keyCode) {
- case 37: // left
- var prevHref = $('link[rel="prev"]').prop('href');
- if (prevHref) {
- window.location.href = prevHref;
- return false;
- }
- break;
- case 39: // right
- var nextHref = $('link[rel="next"]').prop('href');
- if (nextHref) {
- window.location.href = nextHref;
- return false;
- }
- break;
+ && activeElementType !== 'BUTTON') {
+ if (event.altKey || event.ctrlKey || event.metaKey)
+ return;
+
+ if (!event.shiftKey) {
+ switch (event.key) {
+ case 'ArrowLeft':
+ if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS)
+ break;
+ var prevHref = $('link[rel="prev"]').prop('href');
+ if (prevHref) {
+ window.location.href = prevHref;
+ return false;
+ }
+ break;
+ case 'ArrowRight':
+ if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS)
+ break;
+ var nextHref = $('link[rel="next"]').prop('href');
+ if (nextHref) {
+ window.location.href = nextHref;
+ return false;
+ }
+ break;
+ case 'Escape':
+ if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS)
+ break;
+ Documentation.hideSearchWords();
+ return false;
+ }
+ }
+
+ // some keyboard layouts may need Shift to get /
+ switch (event.key) {
+ case '/':
+ if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS)
+ break;
+ Documentation.focusSearchBar();
+ return false;
}
}
});
diff --git a/python/_static/documentation_options.js b/python/_static/documentation_options.js
index 23fc755..7d3ab8c 100644
--- a/python/_static/documentation_options.js
+++ b/python/_static/documentation_options.js
@@ -8,5 +8,7 @@ var DOCUMENTATION_OPTIONS = {
LINK_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt',
- NAVIGATION_WITH_KEYS: false
+ NAVIGATION_WITH_KEYS: false,
+ SHOW_SEARCH_SUMMARY: true,
+ ENABLE_SEARCH_SHORTCUTS: true,
};
\ No newline at end of file
diff --git a/python/_static/searchtools.js b/python/_static/searchtools.js
index 2d77859..0a44e85 100644
--- a/python/_static/searchtools.js
+++ b/python/_static/searchtools.js
@@ -172,10 +172,6 @@ var Search = {
}
// stem the word
var word = stemmer.stemWord(tmp[i].toLowerCase());
- // prevent stemmer from cutting word smaller than two chars
- if(word.length < 3 && tmp[i].length >= 3) {
- word = tmp[i];
- }
var toAppend;
// select the correct list
if (word[0] == '-') {
@@ -276,7 +272,7 @@ var Search = {
setTimeout(function() {
displayNextItem();
}, 5);
- } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
+ } else if (DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY) {
$.ajax({url: requestUrl,
dataType: "text",
complete: function(jqxhr, textstatus) {
@@ -293,7 +289,7 @@ var Search = {
}, 5);
}});
} else {
- // no source available, just display title
+ // just display title
Search.output.append(listItem);
setTimeout(function() {
displayNextItem();
diff --git a/python/searchindex.js b/python/searchindex.js
index eef093f..76b36f6 100644
--- a/python/searchindex.js
+++ b/python/searchindex.js
@@ -1 +1 @@
-Search.setIndex({docnames:["api","cli","concept","index","start","tasks/condition","tasks/datax","tasks/dependent","tasks/flink","tasks/http","tasks/index","tasks/map_reduce","tasks/procedure","tasks/python","tasks/shell","tasks/spark","tasks/sql","tasks/sub_process","tasks/switch","tutorial"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphi [...]
\ No newline at end of file
+Search.setIndex({docnames:["api","cli","concept","index","start","tasks/condition","tasks/datax","tasks/dependent","tasks/flink","tasks/http","tasks/index","tasks/map_reduce","tasks/procedure","tasks/python","tasks/shell","tasks/spark","tasks/sql","tasks/sub_process","tasks/switch","tutorial"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":5,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphi [...]
\ No newline at end of file
diff --git a/zh-cn/docs/dev/user_doc/guide/alert/enterprise-webexteams.html b/zh-cn/docs/dev/user_doc/guide/alert/enterprise-webexteams.html
index 84b0f7e..1cd1894 100644
--- a/zh-cn/docs/dev/user_doc/guide/alert/enterprise-webexteams.html
+++ b/zh-cn/docs/dev/user_doc/guide/alert/enterprise-webexteams.html
@@ -11,9 +11,11 @@
</head>
<body>
<div id="root"><div class="md2html docs-page" data-reactroot=""><header class="header-container header-container-dark"><div class="header-body"><span class="mobile-menu-btn mobile-menu-btn-dark"></span><a href="/zh-cn/index.html"><img class="logo" src="/img/hlogo_white.svg"/></a><div class="search search-dark"><span class="icon-search"></span></div><span class="language-switch language-switch-dark">En</span><div class="header-menu"><div><ul class="ant-menu whiteClass ant-menu-light ant [...]
-<p>如果您需要使用到Webex Teams进行告警，请在告警实例管理里创建告警实例，选择 WebexTeams 插件。WebexTeams的配置样例如下:</p>
+<p>如果您需要使用到Webex Teams进行告警，请在告警实例管理里创建告警实例，选择 WebexTeams 插件。
+你可以选择机器人私聊通知或聊天室通知。
+WebexTeams的配置样例如下:</p>
<p><img src="/img/alert/enterprise-webexteams-plugin.png" alt="enterprise-webexteams-plugin"></p>
-<p>参数配置</p>
+<h2>参数配置</h2>
<ul>
<li>botAccessToken
<blockquote>
@@ -46,6 +48,27 @@
</blockquote>
</li>
</ul>
+<h2>创建一个机器人</h2>
+<p>访问<a href="https://developer.webex.com/docs/api/v1/rooms/create-a-room">官网My-Apps</a>来创建一个机器人，点击<code>Create a New APP</code> 然后选择 <code>Create a Bot</code>，填入机器人信息后获取<code>bot username</code> 和 <code>bot ID</code>以备以下步骤使用。</p>
+<p><img src="/img/alert/enterprise-webexteams-bot.png" alt="enterprise-webexteams-bot-info"></p>
+<h2>创建一个房间</h2>
+<p>访问<a href="https://developer.webex.com/docs/api/v1/rooms/create-a-room">官网开发者APIs</a>来创建一个房间，填入房间名称后获取<code>id</code>(room ID) 和 <code>creatorId</code>以备以下步骤使用。</p>
+<p><img src="/img/alert/enterprise-webexteams-room.png" alt="enterprise-webexteams-room-info"></p>
+<h3>邀请机器人到房间</h3>
+<p>通过机器人的Email(bot username)将机器人添加至房间。</p>
+<h2>发送私聊消息</h2>
+<p>通过这种方式，你可以通过<code>用户邮箱</code>或<code>用户</code>对一个用户私聊窗口发送告警，填入<code>用户</code> 或 <code>用户邮箱</code>(推荐) 和 <code>访问令牌</code>并选择<code>描述</code> <code>personEmail</code> 或 <code>personId</code>。
+<code>用户邮箱</code>是用户注册Email地址。
+<code>用户</code>我们可以从新建房间返回的<code>creatorId</code>中获取。</p>
+<p><img src="/img/alert/enterprise-webexteams-private-form.png" alt="enterprise-webexteams-private-message-form"></p>
+<h3>私聊告警样例</h3>
+<p><img src="/img/alert/enterprise-webexteams-private-msg.png" alt="enterprise-webexteams-private-message-example"></p>
+<h2>发送群聊消息</h2>
+<p>通过这种方式，你可以通过<code>房间</code>向一个房间发送告警，填入<code>房间</code> 和 <code>访问令牌</code>并选择<code>描述</code> <code>roomId</code>。
+<code>房间</code>我们可以从新建房间API返回的<code>id</code>中获取。</p>
+<p><img src="/img/alert/enterprise-webexteams-group-form.png" alt="enterprise-webexteams-group-form"></p>
+<h3>群聊告警消息样例</h3>
+<p><img src="/img/alert/enterprise-webexteams-room-msg.png" alt="enterprise-webexteams-room-message-example"></p>
<p><a href="https://developer.webex.com/docs/bots">WebexTeams申请机器人文档</a>
<a href="https://developer.webex.com/docs/api/v1/messages/create-a-message">WebexTeamsMessage开发文档</a></p>
</div></section><footer class="footer-container"><div class="footer-body"><div><h3>联系我们</h3><h4>有问题需要反馈？请通过以下方式联系我们。</h4></div><div class="contact-container"><ul><li><a href="/zh-cn/community/development/subscribe.html"><img class="img-base" src="/img/emailgray.png"/><img class="img-change" src="/img/emailblue.png"/><p>邮件列表</p></a></li><li><a href="https://twitter.com/dolphinschedule"><img class="img-base" src="/img/twittergray.png"/><img class="img-change" src="/img/twitterblue.png"/><p [...]
diff --git a/zh-cn/docs/dev/user_doc/guide/alert/enterprise-webexteams.json b/zh-cn/docs/dev/user_doc/guide/alert/enterprise-webexteams.json
index 03c43fc..e699d88 100644
--- a/zh-cn/docs/dev/user_doc/guide/alert/enterprise-webexteams.json
+++ b/zh-cn/docs/dev/user_doc/guide/alert/enterprise-webexteams.json
@@ -1,6 +1,6 @@
{
"filename": "enterprise-webexteams.md",
- "__html": "<h1>WebexTeams</h1>\n<p>如果您需要使用到Webex Teams进行告警，请在告警实例管理里创建告警实例，选择 WebexTeams 插件。WebexTeams的配置样例如下:</p>\n<p><img src=\"/img/alert/enterprise-webexteams-plugin.png\" alt=\"enterprise-webexteams-plugin\"></p>\n<p>参数配置</p>\n<ul>\n<li>botAccessToken\n<blockquote>\n<p>在创建机器人时，获得的访问令牌</p>\n</blockquote>\n</li>\n<li>roomID\n<blockquote>\n<p>接受消息的room ID(只支持一个ID)</p>\n</blockquote>\n</li>\n<li>toPersonId\n<blockquote>\n<p>接受消息的用户ID(只支持一个ID)</p>\n</blockquote>\n</li>\n<li>toPersonEma [...]
+ "__html": "<h1>WebexTeams</h1>\n<p>如果您需要使用到Webex Teams进行告警，请在告警实例管理里创建告警实例，选择 WebexTeams 插件。\n你可以选择机器人私聊通知或聊天室通知。\nWebexTeams的配置样例如下:</p>\n<p><img src=\"/img/alert/enterprise-webexteams-plugin.png\" alt=\"enterprise-webexteams-plugin\"></p>\n<h2>参数配置</h2>\n<ul>\n<li>botAccessToken\n<blockquote>\n<p>在创建机器人时，获得的访问令牌</p>\n</blockquote>\n</li>\n<li>roomID\n<blockquote>\n<p>接受消息的room ID(只支持一个ID)</p>\n</blockquote>\n</li>\n<li>toPersonId\n<blockquote>\n<p>接受消息的用户ID(只支持一个ID)</p>\n</blockquote [...]
"link": "/dist/zh-cn/docs/dev/user_doc/guide/alert/enterprise-webexteams.html",
"meta": {}
}
\ No newline at end of file