This is an automated email from the ASF dual-hosted git repository.

zhongjiajie pushed a commit to branch 4.0.4-prepare
in repository 
https://gitbox.apache.org/repos/asf/dolphinscheduler-sdk-python.git

commit 52040113363f17c5fecc6dadce405973e4259a80
Author: Jay Chung <[email protected]>
AuthorDate: Thu Oct 12 18:18:07 2023 +0800

    doc: Add how to config alert (#112)
---
 docs/source/concept.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/docs/source/concept.rst b/docs/source/concept.rst
index a3290e3..0d25ea5 100644
--- a/docs/source/concept.rst
+++ b/docs/source/concept.rst
@@ -123,6 +123,16 @@ Parameter ``execution type`` can be set in
 * Via environment variables, configurations file setting, for more detail 
about those way setting, you can see
   you can read :doc:`config` section.
 
+Alert
+~~~~~
+
+Alert is the way to notify user when workflow instance is success or failed. 
We can set alert with parameter
+``warning_type`` and ``warning_group_id`` in workflow definition.
+
+* ``warning_type`` represent the type of alert, when workflow instance in 
those status, it will trigger alert.
+  The value of ``warning_type`` could be one of ``failure``, ``success``, 
``all``, ``none``.
+* ``warning_group_id`` represent the group of alert, you can get the group id 
from DolphinScheduler web UI.
+
 Tasks
 -----
 

Reply via email to