You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dolphinscheduler.apache.org by GitBox <gi...@apache.org> on 2022/06/30 18:53:05 UTC

[GitHub] [dolphinscheduler] sneh-wha opened a new pull request, #10714: Modified alert doc files.

sneh-wha opened a new pull request, #10714:
URL: https://github.com/apache/dolphinscheduler/pull/10714

   <!--Thanks very much for contributing to Apache DolphinScheduler. Please review https://dolphinscheduler.apache.org/en-us/community/development/pull-request.html before opening a pull request.-->
   
   
   ## Purpose of the pull request
   
   <!--(For example: This pull request adds checkstyle plugin).-->
   
   ## Brief change log
   
   <!--*(for example:)*
     - *Add maven-checkstyle-plugin to root pom.xml*
   -->
   ## Verify this pull request
   
   <!--*(Please pick either of the following options)*-->
   
   This pull request is code cleanup without any test coverage.
   
   *(or)*
   
   This pull request is already covered by existing tests, such as *(please describe tests)*.
   
   (or)
   
   This change added tests and can be verified as follows:
   
   <!--*(example:)*
     - *Added dolphinscheduler-dao tests for end-to-end.*
     - *Added CronUtilsTest to verify the change.*
     - *Manually verified the change by testing locally.* -->
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [dolphinscheduler] zhongjiajie commented on a diff in pull request #10714: Modified alert doc files.

Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on code in PR #10714:
URL: https://github.com/apache/dolphinscheduler/pull/10714#discussion_r911550401


##########
docs/docs/en/guide/alert/script.md:
##########
@@ -7,11 +7,11 @@ The following shows the `Script` configuration example:
 
 ## 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.
+| **Parameter** | **Description** |
+| --- | --- |
+| 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.
\ No newline at end of file
+### Note

Review Comment:
   ```suggestion
   ### Note
   
   ```



##########
docs/docs/en/guide/alert/dingtalk.md:
##########
@@ -1,27 +1,24 @@
 # DingTalk
 
-If you need to use `DingTalk` for alerting, create an alert instance in the alert instance management and select the DingTalk plugin. 
-The following shows the `DingTalk` configuration example:
+If you need to use `DingTalk` for alerting, create an alert instance in the alert instance management and select the `DingTalk` plugin. The following shows the `DingTalk` configuration example:
 
 ![alert-dingtalk](../../../../img/new_ui/dev/alert/alert_dingtalk.png)
 
 ## Parameter Configuration
 
-* Webhook
-  > The format is: https://oapi.dingtalk.com/robot/send?access_token=XXXXXX
-* Keyword
-  > Custom keywords for security settings
-* Secret
-  > Signature of security settings
-* MessageType
-  > Support both text and markdown types
+| **Parameter** | **Description** |
+| --- | --- |
+| Warning Type | Alert on success or failure or both. |
+| WebHook | The format is: [https://oapi.dingtalk.com/robot/send?access\_token=XXXXXX](https://oapi.dingtalk.com/robot/send?access_token=XXXXXX) |
+| Keyword | Custom keywords for security settings. |
+| Secret | Signature of security settings   |
+| Msg Type | Message parse type (support txt, markdown, markdownV2, html). |
+| At User Mobile | 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. The "At User Mobile" represents mobile phone number of the "@person" |
+| At User Ids | The user ID by "@person" |
+| Proxy | The proxy address of the proxy server. |
+| Port | The proxy port of Proxy-Server. |
+| User | Authentication(Username) for the proxy server. |
+| Password | Authentication(Password) for the proxy server. |
 
-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 user ID by "@person"
-* @All
-  > @Everyone
-
-[DingTalk Custom Robot Access Development Documentation](https://open.dingtalk.com/document/robots/custom-robot-access)
+## Reference
+- [DingTalk Custom Robot Access Development Documentation](https://open.dingtalk.com/document/robots/custom-robot-access) 

Review Comment:
   ```suggestion
   
   - [DingTalk Custom Robot Access Development Documentation](https://open.dingtalk.com/document/robots/custom-robot-access) 
   ```



##########
docs/docs/en/guide/alert/script.md:
##########
@@ -1,4 +1,4 @@
-# DingTalk
+# Script

Review Comment:
   Good catch, and thanks to correct it



##########
docs/docs/en/guide/alert/enterprise-wechat.md:
##########
@@ -66,6 +66,5 @@ The following is the `create new group chat` API and `query userId` API example:
 
 ![enterprise-wechat-create-group](../../../../img/alert/enterprise-wechat-query-userid.png)
 
-#### References
-
-Group Chat：https://work.weixin.qq.com/api/doc/90000/90135/90248
\ No newline at end of file
+## Reference
+- Group Chat：https://work.weixin.qq.com/api/doc/90000/90135/90248

Review Comment:
   ```suggestion
   
   - Group Chat：https://work.weixin.qq.com/api/doc/90000/90135/90248
   ```



##########
docs/docs/en/guide/alert/enterprise-webexteams.md:
##########
@@ -60,5 +55,6 @@ The `Room ID` we can acquire it from the `id` of creating a new group chat room
 
 ![enterprise-webexteams-room-message-example](../../../../img/alert/enterprise-webexteams-room-msg.png)
 
-[WebexTeams Application Bot Guide](https://developer.webex.com/docs/bots)
-[WebexTeams Message Guide](https://developer.webex.com/docs/api/v1/messages/create-a-message)
+## References:
+- [WebexTeams Application Bot Guide](https://developer.webex.com/docs/bots)

Review Comment:
   ```suggestion
   
   - [WebexTeams Application Bot Guide](https://developer.webex.com/docs/bots)
   ```



##########
docs/docs/en/guide/alert/telegram.md:
##########
@@ -35,8 +29,7 @@ The following shows the `Telegram` configuration example:
 }
 ```
 
-References:
+## References:

Review Comment:
   ```suggestion
   ## References:
   
   ```



##########
docs/docs/en/guide/alert/telegram.md:
##########
@@ -7,26 +7,20 @@ The following shows the `Telegram` configuration example:
 
 ## Parameter Configuration
 
-* WebHook:
-  > The WebHook of Telegram when use robot to send message
-* botToken
-  > The robot's access token
-* chatId
-  > Sub Telegram Channel
-* parseMode
-  > Message parse type (support txt, markdown, markdownV2, html)
-* EnableProxy
-  > Enable proxy sever
-* Proxy
-  > the proxy address of the proxy server
-* Port
-  > the proxy port of Proxy-Server
-* User
-  > Authentication(Username) for the proxy server
-* Password
-  > Authentication(Password) for the proxy server
-
-**NOTICE**：The webhook needs to be able to receive and use the same JSON body of HTTP POST that DolphinScheduler constructs and the following shows the JSON body:
+| **Parameter** | **Description** |
+| --- | --- |
+| WebHook | The WebHook of Telegram when use robot to send message. |
+| botToken | The access token of robot. |
+| chatId | Sub Telegram Channel. |
+| parseMode | Message parse type (support txt, markdown, markdownV2, html). |
+| EnableProxy | Enable proxy sever. |
+| Proxy | The proxy address of the proxy server. |
+| Port | The proxy port of proxy server. |
+| User | Authentication(Username) for the proxy server. |
+| Password | Authentication(Password) for the proxy server. |
+
+### NOTE
+The webhook needs to be able to receive and use the same JSON body of HTTP POST that DolphinScheduler constructs and the following shows the JSON body:

Review Comment:
   ```suggestion
   
   The webhook needs to be able to receive and use the same JSON body of HTTP POST that DolphinScheduler constructs and the following shows the JSON body:
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [dolphinscheduler] zhongjiajie merged pull request #10714: Modified alert doc files.

Posted by GitBox <gi...@apache.org>.
zhongjiajie merged PR #10714:
URL: https://github.com/apache/dolphinscheduler/pull/10714


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org