[Doc] Add engine start parameter explanation (apache#7062)

zilliztech · Jul 10, 2024 · a413801 · a413801
1 parent 38528d6
commit a413801
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/docs/en/start-v2/locally/quick-start-seatunnel-engine.md b/docs/en/start-v2/locally/quick-start-seatunnel-engine.md
@@ -58,9 +58,15 @@ More information about config please check [config concept](../../concept/config
 
 You could start the application by the following commands
 
+:::tip
+
+Starting from version 2.3.1, the parameter -e in seatunnel.sh is deprecated, use -m instead.
+
+:::
+
 ```shell
 cd "apache-seatunnel-${version}"
-./bin/seatunnel.sh --config ./config/v2.batch.config.template -e local
+./bin/seatunnel.sh --config ./config/v2.batch.config.template -m local
 
 ```
 

diff --git a/docs/zh/start-v2/locally/quick-start-seatunnel-engine.md b/docs/zh/start-v2/locally/quick-start-seatunnel-engine.md
@@ -58,9 +58,15 @@ sink {
 
 您可以通过以下命令启动应用程序
 
+:::tip
+
+从2.3.1版本开始，seatunnel.sh中的-e参数被废弃，请改用-m参数。
+
+:::
+
 ```shell
 cd "apache-seatunnel-${version}"
-./bin/seatunnel.sh --config ./config/v2.batch.config.template -e local
+./bin/seatunnel.sh --config ./config/v2.batch.config.template -m local
 
 ```