Pārlūkot izejas kodu

[Bug] [Website-9764]add script doc to the alert function (#9765)

* add script doc to the alert function

* add script doc to the alert function modify docsdev.js
Tq 3 gadi atpakaļ
vecāks
revīzija
e3070d9fa3

+ 8 - 0
docs/configs/docsdev.js

@@ -241,6 +241,10 @@ export default {
                                 title: 'Enterprise Webexteams',
                                 link: '/en-us/docs/dev/user_doc/guide/alert/enterprise-webexteams.html',
                             },
+                            {
+                                title: 'Script',
+                                link: '/en-us/docs/dev/user_doc/guide/alert/script.html',
+                            },
                         ],
                     },
                     {
@@ -559,6 +563,10 @@ export default {
                                 title: 'Webexteams',
                                 link: '/zh-cn/docs/dev/user_doc/guide/alert/enterprise-webexteams.html',
                             },
+                            {
+                                title: '脚本告警',
+                                link: '/zh-cn/docs/dev/user_doc/guide/alert/script.html',
+                            },
                         ],
                     },
                     {

+ 17 - 0
docs/docs/en/guide/alert/script.md

@@ -0,0 +1,17 @@
+# DingTalk
+
+If you need to use `Shell script` for alerting, create an alert instance in the alert instance management and select the `Script` plugin. 
+The following shows the `Script` configuration example:
+
+![dingtalk-plugin](/img/alert/script-plugin.png)
+
+## Parameter Configuration
+
+* User Params
+  > User defined parameters will pass to the script.
+* Script Path
+  > The file location path in the server.
+* Type
+  > Support `Shell` script.
+
+**_Notice:_** please consider the script file access privileges with the executing tenant.

+ 17 - 0
docs/docs/zh/guide/alert/script.md

@@ -0,0 +1,17 @@
+# Script脚本
+
+如果您需要使用到`Shell`脚本进行告警,请在告警实例管理里创建告警实例,选择`Script`插件。`Script`的配置样例如下:
+
+![dingtalk-plugin](/img/alert/script-plugin.png)
+
+参数配置
+
+* 自定义参数
+  > 用户自定义的参数将被传入脚本执行
+* 脚本路径
+  > 脚本在服务器上的文件位置
+* 脚本类型
+  > 支持`Shell`脚本
+
+**_注意:_** 请注意脚本的读写权限与执行租户的关系
+

BIN
docs/img/alert/script-plugin.png