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/24 03:32:27 UTC

[GitHub] [dolphinscheduler] zhongjiajie commented on a diff in pull request #10119: [Docment][Feature] Refactor local parameter docment

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