This is an automated email from the ASF dual-hosted git repository.
SbloodyS pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/dolphinscheduler.git
The following commit(s) were added to refs/heads/dev by this push:
new 3ea75b1054 [Doc-18680] Fix Shell task documentation inconsistencies
(#18681)
3ea75b1054 is described below
commit 3ea75b105431412a306935ade3abcb04d13bf2e9
Author: chovygo <[email protected]>
AuthorDate: Sat Oct 10 12:28:17 2026 +0800
[Doc-18680] Fix Shell task documentation inconsistencies (#18681)
---
docs/docs/en/guide/task/appendix.md | 1 +
docs/docs/en/guide/task/shell.md | 10 ++++++----
docs/docs/zh/guide/task/appendix.md | 1 -
docs/docs/zh/guide/task/shell.md | 8 +++++++-
4 files changed, 14 insertions(+), 6 deletions(-)
diff --git a/docs/docs/en/guide/task/appendix.md
b/docs/docs/en/guide/task/appendix.md
index 57cb5dbc31..a77b0fe9f6 100644
--- a/docs/docs/en/guide/task/appendix.md
+++ b/docs/docs/en/guide/task/appendix.md
@@ -12,6 +12,7 @@ DolphinScheduler task plugins share some common default
parameters. Each type of
| Task Priority | When the number of the worker threads is
insufficient, the worker executes task according to the priority. When two
tasks have the same priority, the worker will execute them in `first come first
served` fashion.
|
| Worker Group | Machines which execute the tasks. If you choose
`default`, scheduler will send the task to a random worker.
|
| Task Group Name | Resource group of tasks. It will not take effect
if not configured.
|
+| Group Priority | The priority of this task within a task group.
|
| Environment Name | Environment to execute the task.
|
| Number of Failed Retries | The number of task retries for failures. You
could select it by drop-down menu or fill it manually.
|
| Failure Retry Interval | Interval of task retries for failures. You could
select it by drop-down menu or fill it manually.
|
diff --git a/docs/docs/en/guide/task/shell.md b/docs/docs/en/guide/task/shell.md
index 059ad7c6a6..b43c1b460c 100644
--- a/docs/docs/en/guide/task/shell.md
+++ b/docs/docs/en/guide/task/shell.md
@@ -2,12 +2,12 @@
## Overview
-Shell task type, used to create a shell type task and execute a series of
shell scripts. When the worker executes this task, a temporary shell script is
generated and executed using the linux user with the same name as the tenant.
+The Shell task type is used to create Shell tasks and execute a series of
shell scripts. When the worker executes this task, a temporary shell script is
generated and executed using the linux user with the same name as the tenant.
## Create Task
- Click `Project Management -> Project Name -> Workflow Definition`, and click
the `Create Workflow` button to enter the DAG editing page.
-- Drag from the toolbar <img src="../../../../img/tasks/icons/shell.png"
width="15"/> to the canvas.
+- Drag <img src="../../../../img/tasks/icons/shell.png" width="15"/> from the
toolbar to the canvas.
## Task Parameters
@@ -34,8 +34,10 @@ This example simulates a custom parameter task. In order to
reuse existing tasks
## Note
-The shell task type resolves whether the task log contains
```application_xxx_xxx``` to determine whether is the yarn task. If so, the
corresponding application
-will be use to judge the running state of the current shell node. At this
time, if stops the operation of the workflow, the corresponding
```application_id```
+The shell task type resolves whether the task log contains
```application_xxx_xxx``` to determine whether it is a Yarn task. If so, the
corresponding application
+will be used to judge the running state of the current shell node. At this
time, if the operation of the workflow is stopped, the corresponding
```application_id```
will be killed.
If you want to use resource files in Shell tasks, you can upload corresponding
files through the resource center and then use the resources in the Shell task.
Reference: [file-manage](../resource/file-manage.md).
+
+When referencing resources via API, use the `resourceName` field to specify
the resource path. The `id` and `res` fields in `ResourceInfo` are deprecated
(@Deprecated) and no longer recommended.
diff --git a/docs/docs/zh/guide/task/appendix.md
b/docs/docs/zh/guide/task/appendix.md
index 9cc9002dd3..3966e79ea7 100644
--- a/docs/docs/zh/guide/task/appendix.md
+++ b/docs/docs/zh/guide/task/appendix.md
@@ -8,7 +8,6 @@
|----------|--------------------------------------------------------------------------------------------------------------------------------------|
| 任务名称 | 任务的名称，同一个工作流定义中的节点名称不能重复。
|
| 运行标志 | 标识这个节点是否需要调度执行，如果不需要执行，可以打开禁止执行开关。
|
-| 缓存执行 |
标识这个节点是否需要进行缓存，如果缓存，则对于相同标识（相同任务版本，相同任务定义，相同参数传入）的任务进行缓存，运行时若已经存在缓存过的任务时，不再重复执行，直接复用结果。
|
| 描述 | 当前节点的功能描述。
|
| 任务优先级 | worker线程数不足时，根据优先级从高到低依次执行任务，优先级一样时根据先到先得原则执行。
|
| Worker分组 | 设置分组后，任务会被分配给worker组的机器机执行。若选择Default，则会随机选择一个worker执行。
|
diff --git a/docs/docs/zh/guide/task/shell.md b/docs/docs/zh/guide/task/shell.md
index 82311638b3..1387be4c9d 100644
--- a/docs/docs/zh/guide/task/shell.md
+++ b/docs/docs/zh/guide/task/shell.md
@@ -12,7 +12,11 @@ Shell 任务类型，用于创建 Shell 类型的任务并执行一系列的 She
## 任务参数
- 默认参数说明请参考 [DolphinScheduler 任务参数附录](appendix.md) 的 `默认任务参数` 一栏。
-- 除上述默认参数，此任务没有其他参数
+
+| **参数** | **描述** |
+|--------|--------------------------------------------|
+| 脚本 | 用户开发的 SHELL 程序。 |
+| 自定义参数 | Shell 的用户自定义参数，将使用 `${variable}` 替换脚本中的内容。 |
## 任务样例
@@ -34,3 +38,5 @@ Shell 任务类型，用于创建 Shell 类型的任务并执行一系列的 She
Shell 任务类型通过解析任务日志是否包含 ```application_xxx_xxx``` 的内容来判断是否 Yarn 任务，如果是则会将相应的
```application_id``` 的状态作为当前 Shell 节点的运行状态判断，此时如果操作停止工作流则会 Kill 相应的
```application_id```
如果 Shell 任务中需要使用到用户自定义的脚本，可通过资源中心来上传对应的文件然后在 Shell
任务中引用他们，可参考：[文件管理](../resource/file-manage.md)。
+
+通过 API 引用资源时，请使用 `resourceName` 字段指定资源路径。`ResourceInfo` 中的 `id` 和 `res`
字段已废弃（@Deprecated），不再推荐使用。
