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/05/19 07:03:04 UTC

[GitHub] [dolphinscheduler] QuakeWang opened a new pull request, #10119: [Docment][Feature] Refactor local parameter docment

QuakeWang opened a new pull request, #10119:
URL: https://github.com/apache/dolphinscheduler/pull/10119

   ref: #9989 


-- 
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 #10119: [Docment][Feature] Refactor local parameter docment

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


##########
docs/docs/en/guide/parameter/local.md:
##########
@@ -6,14 +6,23 @@ Parameters configured on the task definition page, the scope of this parameter i
 
 ## Usage
 
-Usage of local parameters is: at the task define page, click the '+' beside the 'Custom Parameters' and fill in the key and value to save:
+Usage of local parameters is: at the task define page, click the '+' beside the 'Custom Parameters' and fill in the key and value to save.
 
-<p align="center">
-     <img src="/img/supplement_local_parameter_en.png" width="80%" />
-</p>
+## Examples
 
-<p align="center">
-     <img src="/img/global_parameter_en.png" width="80%" />
-</p>
+This example shows how to use local parameters to print the current date. Create a Shell task and write a script with the content 'echo ${dt}'. Click ** custom parameter ** in the configuration bar, and the configuration is as follows:

Review Comment:
   ```suggestion
   This example shows how to use local parameters to print the current date. Create a Shell task and write a script with the content `echo ${dt}`. Click **custom parameter** in the configuration bar, and the configuration is as follows:
   ```



##########
docs/docs/en/guide/parameter/local.md:
##########
@@ -6,14 +6,23 @@ Parameters configured on the task definition page, the scope of this parameter i
 
 ## Usage
 
-Usage of local parameters is: at the task define page, click the '+' beside the 'Custom Parameters' and fill in the key and value to save:
+Usage of local parameters is: at the task define page, click the '+' beside the 'Custom Parameters' and fill in the key and value to save.
 
-<p align="center">
-     <img src="/img/supplement_local_parameter_en.png" width="80%" />
-</p>
+## Examples
 
-<p align="center">
-     <img src="/img/global_parameter_en.png" width="80%" />
-</p>
+This example shows how to use local parameters to print the current date. Create a Shell task and write a script with the content 'echo ${dt}'. Click ** custom parameter ** in the configuration bar, and the configuration is as follows:
 
-If you want to call the [built-in parameter](built-in.md) in the local parameters, fill in thevalue of built-in parameters in `value`. As in the above figure, `${biz_date}` and `${curdate}`.
\ No newline at end of file
+![local-parameter01](/img/new_ui/dev/parameter/local_parameter01.png)
+
+Parameters:
+
+-dt: indicates the parameter name
+-in: IN indicates that local parameters can only be used on the current node, and OUT indicates that local parameters can be transmitted to the downstream
+- DATE: indicates the DATE of the data type
+- $[YYYY-MM-DD] : indicates a built-in parameter derived from a user-defined format

Review Comment:
   ```suggestion
   - dt: indicates the parameter name
   - in: IN indicates that local parameters can only be used on the current node, and OUT indicates that local parameters can be transmitted to the downstream
   - DATE: indicates the DATE of the data type
   - $[YYYY-MM-DD] : indicates a built-in parameter derived from a user-defined format
   ```



-- 
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] QuakeWang commented on pull request #10119: [Docment][Feature] Refactor local parameter docment

Posted by GitBox <gi...@apache.org>.
QuakeWang commented on PR #10119:
URL: https://github.com/apache/dolphinscheduler/pull/10119#issuecomment-1133839052

   > Do you finish your change now? @QuakeWang
   
   I have changed it. PTAL


-- 
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 pull request #10119: [Docment][Feature] Refactor local parameter docment

Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on PR #10119:
URL: https://github.com/apache/dolphinscheduler/pull/10119#issuecomment-1132431983

   Do you finish your change now? @QuakeWang 


-- 
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] SbloodyS commented on a diff in pull request #10119: [Docment][Feature] Refactor local parameter docment

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


##########
docs/docs/en/guide/parameter/local.md:
##########
@@ -2,18 +2,27 @@
 
 ## Scope
 
-Parameters configured on the task definition page, the scope of this parameter is inside this task only. But if you configure according to [Refer to Parameter Context](context.md), it could pass to downstream tasks.
+Local parameters are used only for a single task node. Parameters configured on the task definition page, the scope of this parameter is inside this task only. But if you configure according to [Refer to Parameter Context](context.md), it could pass to downstream tasks.

Review Comment:
   I think the previous version's description is better. We should keep it as it is.



##########
docs/docs/en/guide/parameter/local.md:
##########
@@ -2,18 +2,27 @@
 
 ## Scope
 
-Parameters configured on the task definition page, the scope of this parameter is inside this task only. But if you configure according to [Refer to Parameter Context](context.md), it could pass to downstream tasks.
+Local parameters are used only for a single task node. Parameters configured on the task definition page, the scope of this parameter is inside this task only. But if you configure according to [Refer to Parameter Context](context.md), it could pass to downstream tasks.
 
 ## Usage
 
-Usage of local parameters is: at the task define page, click the '+' beside the 'Custom Parameters' and fill in the key and value to save:
+Usage of local parameters is: at the task define page, click the '+' beside the 'Custom Parameters' and fill in the key and value to save.
 
-<p align="center">
-     <img src="/img/supplement_local_parameter_en.png" width="80%" />
-</p>
+## Examples
 
-<p align="center">
-     <img src="/img/global_parameter_en.png" width="80%" />
-</p>
+This example uses local parameters to print the current date. Create a Shell task and write a script with the content 'echo ${dt}'. Click ** custom parameter ** in the configuration bar, and the configuration is as follows:

Review Comment:
   Do you think this is better? ```This example shows how to use local parameters to print the current date.```



##########
docs/docs/zh/guide/parameter/local.md:
##########
@@ -2,18 +2,27 @@
 
 ## 作用域
 
-在任务定义页面配置的参数，默认作用域仅限该任务，如果配置了[参数传递](context.md)则可将该参数作用到下游任务中。
+本地参数是只针对单个任务工作流节点的参数。在任务定义页面配置的参数，默认作用域仅限该任务，如果配置了[参数传递](context.md)则可将该参数作用到下游任务中。
 
 ## 使用方式
 
-本地参数配置方式如下：在任务定义页面，点击“自定义参数”右边的加号，填写对应的变量名称和对应的值，保存即可
+本地参数配置方式如下：在任务定义页面，点击“自定义参数”右边的加号，填写对应的变量名称和对应的值，保存即可。
 
-<p align="center">
-   <img src="/img/supplement_local_parameter.png" width="80%" />
- </p>
+## 任务样例
 
-<p align="center">
-   <img src="/img/global_parameter.png" width="80%" />
-</p>
+该样例使用本地参数，打印输出当前日期。创建一个 Shell 任务，并编写脚本内容为 `echo ${dt}`。点击配置栏中的**自定义参数**，配置如下图所示：

Review Comment:
   本样例展示了如何使用本地参数.



##########
docs/docs/zh/guide/parameter/local.md:
##########
@@ -2,18 +2,27 @@
 
 ## 作用域
 
-在任务定义页面配置的参数，默认作用域仅限该任务，如果配置了[参数传递](context.md)则可将该参数作用到下游任务中。
+本地参数是只针对单个任务工作流节点的参数。在任务定义页面配置的参数，默认作用域仅限该任务，如果配置了[参数传递](context.md)则可将该参数作用到下游任务中。

Review Comment:
   Same as english's.



-- 
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 #10119: [Docment][Feature] Refactor local parameter docment

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


-- 
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 pull request #10119: [Docment][Feature] Refactor local parameter docment

Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on PR #10119:
URL: https://github.com/apache/dolphinscheduler/pull/10119#issuecomment-1134120182

   I had restart the failed CI


-- 
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] QuakeWang commented on a diff in pull request #10119: [Docment][Feature] Refactor local parameter docment

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


##########
docs/docs/en/guide/parameter/local.md:
##########
@@ -2,18 +2,27 @@
 
 ## Scope
 
-Parameters configured on the task definition page, the scope of this parameter is inside this task only. But if you configure according to [Refer to Parameter Context](context.md), it could pass to downstream tasks.
+Local parameters are used only for a single task node. Parameters configured on the task definition page, the scope of this parameter is inside this task only. But if you configure according to [Refer to Parameter Context](context.md), it could pass to downstream tasks.
 
 ## Usage
 
-Usage of local parameters is: at the task define page, click the '+' beside the 'Custom Parameters' and fill in the key and value to save:
+Usage of local parameters is: at the task define page, click the '+' beside the 'Custom Parameters' and fill in the key and value to save.
 
-<p align="center">
-     <img src="/img/supplement_local_parameter_en.png" width="80%" />
-</p>
+## Examples
 
-<p align="center">
-     <img src="/img/global_parameter_en.png" width="80%" />
-</p>
+This example uses local parameters to print the current date. Create a Shell task and write a script with the content 'echo ${dt}'. Click ** custom parameter ** in the configuration bar, and the configuration is as follows:

Review Comment:
   > Do you think this is better? `This example shows how to use local parameters to print the current date.`
   
   Great I will update it.



-- 
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