docs(rule): doc of triggered prop (#3338)

Signed-off-by: Jiyong Huang <huangjy@emqx.io>
lf-edge · Oct 28, 2024 · bfe2751 · bfe2751
1 parent 9463f7d
commit bfe2751
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 8 deletions.
diff --git a/docs/en_US/guide/rules/overview.md b/docs/en_US/guide/rules/overview.md
@@ -38,6 +38,7 @@ The table below is a detailed explanation of the row component:
 | actions        | required if graph is not defined | An array of sink actions                                                     |
 | graph          | required if sql is not defined   | The json presentation of the rule's DAG(directed acyclic graph)              |
 | options        | true                             | A map of options                                                             |
+| triggerd       | true                             | Whether to start the rule after creation. Default is true.                   |
 
 ## Rule Logic
 

diff --git a/docs/zh_CN/guide/rules/overview.md b/docs/zh_CN/guide/rules/overview.md
@@ -24,14 +24,15 @@
 
 ## 参数
 
-| 参数名     | 是否可选                  | 说明                                |
-|---------|-----------------------|-----------------------------------|
-| id      | 否                     | 规则 id, 规则 id 在同一 eKuiper 实例中必须唯一。 |
-| name    | 是                     | 规则显示的名字或者描述。                      |
-| sql     | 如果 graph 未定义，则该属性必须定义 | 为规则运行的 sql 查询                     |
-| actions | 如果 graph 未定义，则该属性必须定义 | Sink 动作数组                         |
-| graph   | 如果 sql 未定义，则该属性必须定义   | 规则有向无环图的 JSON 表示                  |
-| options | 是                     | 选项列表                              |
+| 参数名      | 是否可选                  | 说明                                |
+|----------|-----------------------|-----------------------------------|
+| id       | 否                     | 规则 id, 规则 id 在同一 eKuiper 实例中必须唯一。 |
+| name     | 是                     | 规则显示的名字或者描述。                      |
+| sql      | 如果 graph 未定义，则该属性必须定义 | 为规则运行的 sql 查询                     |
+| actions  | 如果 graph 未定义，则该属性必须定义 | Sink 动作数组                         |
+| graph    | 如果 sql 未定义，则该属性必须定义   | 规则有向无环图的 JSON 表示                  |
+| options  | 是                     | 选项列表                              |
+| triggerd | 是                     | 布尔值，设置是否创建完规则后立刻运行，默认是 true       |
 
 ## 规则逻辑