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/07/01 08:40:59 UTC
[GitHub] [dolphinscheduler] zhongjiajie commented on a diff in pull request #10711: Modified project doc files.
zhongjiajie commented on code in PR #10711:
URL: https://github.com/apache/dolphinscheduler/pull/10711#discussion_r911747932
##########
docs/docs/en/guide/project/workflow-definition.md:
##########
@@ -94,17 +94,17 @@ The following are the operation functions of the workflow definition list:
## Run the task alone
-- Right-click the task and click the "Start" button (only online tasks can be clicked to run)
+- Right-click the task and click the "`Start`" button (only online tasks can be clicked to run).
Review Comment:
```suggestion
- Right-click the task and click the `Start` button (only online tasks can be clicked to run).
```
##########
docs/docs/en/guide/project/workflow-definition.md:
##########
@@ -28,54 +28,54 @@
-- **Save workflow definition:** Click the "Save" button, and the "Set DAG chart name" window pops up, as shown in the figure below. Enter the workflow definition name, workflow definition description, and set global parameters (optional, refer to [global parameters](../parameter/global.md)), click the "Add" button to finish workflow definition creation.
+- **Save workflow definition:** Click the "`Save`" button, and the "Set DAG chart name" window pops up, as shown in the figure below. Enter the workflow definition name, workflow definition description, and set global parameters (optional, refer to [global parameters](../parameter/global.md)), click the "`Add`" button to finish workflow definition creation.
Review Comment:
```suggestion
- **Save workflow definition:** Click the `Save` button, and the "Set DAG chart name" window pops up, as shown in the figure below. Enter the workflow definition name, workflow definition description, and set global parameters (optional, refer to [global parameters](../parameter/global.md)), click the `Add` button to finish workflow definition creation.
```
##########
docs/docs/en/guide/project/workflow-definition.md:
##########
@@ -115,10 +115,10 @@ The following are the operation functions of the workflow definition list:
- Failure strategy, notification strategy, process priority, worker group, notification group, recipient, and CC are the same as workflow running parameters.
- Click the "Create" button to create the timing. Now the timing status is "**Offline**" and the timing needs to be **Online** to make effect.
-- Timing online: Click the "Timing Management" button <img src="../../../../img/timeManagement.png" width="35"/>, enter the timing management page, click the "online" button, the timing status will change to "online", as shown in the below figure, the workflow makes effect regularly.
+- Timing online: Click the "`Timing Management`" button <img src="../../../../img/timeManagement.png" width="35"/>, enter the timing management page, click the "`online`" button, the timing status will change to "`online`", as shown in the below figure, the workflow makes effect regularly.
Review Comment:
```suggestion
- Timing online: Click the `Timing Management` button <img src="../../../../img/timeManagement.png" width="35"/>, enter the timing management page, click the `online` button, the timing status will change to `online`, as shown in the below figure, the workflow makes effect regularly.
```
##########
docs/docs/en/guide/project/workflow-definition.md:
##########
@@ -28,54 +28,54 @@
-- **Save workflow definition:** Click the "Save" button, and the "Set DAG chart name" window pops up, as shown in the figure below. Enter the workflow definition name, workflow definition description, and set global parameters (optional, refer to [global parameters](../parameter/global.md)), click the "Add" button to finish workflow definition creation.
+- **Save workflow definition:** Click the "`Save`" button, and the "Set DAG chart name" window pops up, as shown in the figure below. Enter the workflow definition name, workflow definition description, and set global parameters (optional, refer to [global parameters](../parameter/global.md)), click the "`Add`" button to finish workflow definition creation.
> For other types of tasks, please refer to [Task Node Type and Parameter Settings](#TaskParamers). <!-- markdown-link-check-disable-line -->
## Workflow Definition Operation Function
-Click Project Management -> Workflow -> Workflow Definition to enter the workflow definition page, as shown below:
+Click `Project Management -> Workflow -> Workflow Definition` to enter the workflow definition page, as shown below:
The following are the operation functions of the workflow definition list:
- **Edit:** Only "Offline" workflow definitions can be edited. Workflow DAG editing is the same as [Create Workflow Definition](#creatDag) <!-- markdown-link-check-disable-line -->
-- **Online:** When the workflow status is "Offline", used to make workflow online. Only the workflow in the "Online" state can run, but cannot edit
-- **Offline:** When the workflow status is "Online", used to make workflow offline. Only the workflow in the "Offline" state can be edited, but cannot run
+- **Online:** When the workflow status is "Offline", used to make workflow online. Only the workflow in the "Online" state can run, but cannot edit.
+- **Offline:** When the workflow status is "Online", used to make workflow offline. Only the workflow in the "Offline" state can be edited, but cannot run.
- **Run:** Only workflow in the online state can run. See [2.3.3 Run Workflow](#run-the-workflow) for the operation steps.
-- **Timing:** Timing can only set to online workflows, and the system automatically schedules to run the workflow on time. The status after creating a timing setting is "offline", and the timing must set online on the timing management page to make effect. See [2.3.4 Workflow Timing](#workflow-timing) for timing operation steps
-- **Timing Management:** The timing management page can edit, online or offline and delete timing
+- **Timing:** Timing can only set to online workflows, and the system automatically schedules to run the workflow on time. The status after creating a timing setting is "offline", and the timing must set online on the timing management page to make effect. See [2.3.4 Workflow Timing](#workflow-timing) for timing operation steps.
+- **Timing Management:** The timing management page can edit, online or offline and delete timing.
- **Delete:** Delete the workflow definition. In the same project, only the workflow definition created by yourself can be deleted, and the workflow definition of other users cannot be deleted. If you need to delete it, please contact the user who created it or the administrator.
-- **Download:** Download workflow definition to local
+- **Download:** Download workflow definition to local.
- **Tree Diagram:** Display the task node type and task status in a tree structure, as shown in the figure below:
## Run the Workflow
-- Click Project Management -> Workflow -> Workflow Definition to enter the workflow definition page, as shown in the figure below, click the "Go Online" button <img src="../../../../img/online.png" width="35"/>to make workflow online.
+- Click `Project Management -> Workflow -> Workflow Definition` to enter the workflow definition page, as shown in the figure below, click the "Go Online" button <img src="../../../../img/online.png" width="35"/>to make workflow online.
-- Click the "Run" button to pop up the startup parameter setting window, as shown in the figure below, set the startup parameters, click the "Run" button in the pop-up box, the workflow starts running, and the workflow instance page generates a workflow instance.
+- Click the "`Run`" button to pop up the startup parameter setting window, as shown in the figure below, set the startup parameters, click the "`Run`" button in the pop-up box, the workflow starts running, and the workflow instance page generates a workflow instance.
Review Comment:
```suggestion
- Click the `Run` button to pop up the startup parameter setting window, as shown in the figure below, set the startup parameters, click the `Run` button in the pop-up box, the workflow starts running, and the workflow instance page generates a workflow instance.
```
##########
docs/docs/en/guide/project/workflow-definition.md:
##########
@@ -12,13 +12,13 @@
- **Add parameter settings for shell task:**
-1. Fill in the "Node Name", "Description" and "Script" fields;
-2. Check “Normal” for “Run Flag”. If “Prohibit Execution” is checked, the task will not execute when the workflow runs;
-3. Select "Task Priority": when the number of worker threads is insufficient, high priority tasks will execute first in the execution queue, and tasks with the same priority will execute in the order of first in, first out;
+1. Fill in the "`Node Name`", "`Description`" and "`Script`" fields;
+2. Check “`Normal`” for “`Run Flag`”. If “`Prohibit Execution`” is checked, the task will not execute when the workflow runs;
Review Comment:
```suggestion
2. Check `Normal` for `Run Flag`. If `Prohibit Execution` is checked, the task will not execute when the workflow runs;
```
##########
docs/docs/en/guide/project/workflow-definition.md:
##########
@@ -12,13 +12,13 @@
- **Add parameter settings for shell task:**
-1. Fill in the "Node Name", "Description" and "Script" fields;
-2. Check “Normal” for “Run Flag”. If “Prohibit Execution” is checked, the task will not execute when the workflow runs;
-3. Select "Task Priority": when the number of worker threads is insufficient, high priority tasks will execute first in the execution queue, and tasks with the same priority will execute in the order of first in, first out;
+1. Fill in the "`Node Name`", "`Description`" and "`Script`" fields;
+2. Check “`Normal`” for “`Run Flag`”. If “`Prohibit Execution`” is checked, the task will not execute when the workflow runs;
+3. Select "`Task Priority`": when the number of worker threads is insufficient, high priority tasks will execute first in the execution queue, and tasks with the same priority will execute in the order of first in, first out;
Review Comment:
```suggestion
3. Select `Task Priority`: when the number of worker threads is insufficient, high priority tasks will execute first in the execution queue, and tasks with the same priority will execute in the order of first in, first out;
```
##########
docs/docs/en/guide/project/workflow-definition.md:
##########
@@ -115,10 +115,10 @@ The following are the operation functions of the workflow definition list:
- Failure strategy, notification strategy, process priority, worker group, notification group, recipient, and CC are the same as workflow running parameters.
- Click the "Create" button to create the timing. Now the timing status is "**Offline**" and the timing needs to be **Online** to make effect.
-- Timing online: Click the "Timing Management" button <img src="../../../../img/timeManagement.png" width="35"/>, enter the timing management page, click the "online" button, the timing status will change to "online", as shown in the below figure, the workflow makes effect regularly.
+- Timing online: Click the "`Timing Management`" button <img src="../../../../img/timeManagement.png" width="35"/>, enter the timing management page, click the "`online`" button, the timing status will change to "`online`", as shown in the below figure, the workflow makes effect regularly.
## Import Workflow
-Click Project Management -> Workflow -> Workflow Definition to enter the workflow definition page, click the "Import Workflow" button to import the local workflow file, the workflow definition list displays the imported workflow and the status is offline.
+Click `Project Management -> Workflow -> Workflow Definition` to enter the workflow definition page, click the "`Import Workflow`" button to import the local workflow file, the workflow definition list displays the imported workflow and the status is offline.
Review Comment:
```suggestion
Click `Project Management -> Workflow -> Workflow Definition` to enter the workflow definition page, click the `Import Workflow` button to import the local workflow file, the workflow definition list displays the imported workflow and the status is offline.
```
##########
docs/docs/en/guide/project/workflow-definition.md:
##########
@@ -12,13 +12,13 @@
- **Add parameter settings for shell task:**
-1. Fill in the "Node Name", "Description" and "Script" fields;
-2. Check “Normal” for “Run Flag”. If “Prohibit Execution” is checked, the task will not execute when the workflow runs;
-3. Select "Task Priority": when the number of worker threads is insufficient, high priority tasks will execute first in the execution queue, and tasks with the same priority will execute in the order of first in, first out;
+1. Fill in the "`Node Name`", "`Description`" and "`Script`" fields;
+2. Check “`Normal`” for “`Run Flag`”. If “`Prohibit Execution`” is checked, the task will not execute when the workflow runs;
+3. Select "`Task Priority`": when the number of worker threads is insufficient, high priority tasks will execute first in the execution queue, and tasks with the same priority will execute in the order of first in, first out;
4. Timeout alarm (optional): check the timeout alarm, timeout failure, and fill in the "timeout period". When the task execution time exceeds **timeout period**, an alert email will send and the task timeout fails;
-5. Resources (optional). Resources are files create or upload in the Resource Center -> File Management page. For example, the file name is `test.sh`, and the command to call the resource in the script is `sh test.sh`;
+5. Resources (optional). Resources are files create or upload in the `Resource Center -> File Management` page. For example, the file name is `test.sh`, and the command to call the resource in the script is `sh test.sh`;
6. Customize parameters (optional);
-7. Click the "Confirm Add" button to save the task settings.
+7. Click the "`Confirm Add`" button to save the task settings.
Review Comment:
```suggestion
7. Click the `Confirm Add` button to save the task settings.
```
##########
docs/docs/en/guide/project/workflow-definition.md:
##########
@@ -2,7 +2,7 @@
## Create workflow definition
-- Click Project Management -> Workflow -> Workflow Definition, enter the workflow definition page, and click the "Create Workflow" button to enter the **workflow DAG edit** page, as shown in the following figure:
+- Click `Project Management -> Workflow -> Workflow Definition`, enter the `Workflow Definition` page, and click the "`Create Workflow`" button to enter the **workflow DAG edit** page, as shown in the following figure:
Review Comment:
```suggestion
- Click `Project Management -> Workflow -> Workflow Definition`, enter the `Workflow Definition` page, and click the `Create Workflow` button to enter the **workflow DAG edit** page, as shown in the following figure:
```
##########
docs/docs/en/guide/project/workflow-definition.md:
##########
@@ -12,13 +12,13 @@
- **Add parameter settings for shell task:**
-1. Fill in the "Node Name", "Description" and "Script" fields;
-2. Check “Normal” for “Run Flag”. If “Prohibit Execution” is checked, the task will not execute when the workflow runs;
-3. Select "Task Priority": when the number of worker threads is insufficient, high priority tasks will execute first in the execution queue, and tasks with the same priority will execute in the order of first in, first out;
+1. Fill in the "`Node Name`", "`Description`" and "`Script`" fields;
Review Comment:
```suggestion
1. Fill in the `Node Name`, `Description` and `Script` fields;
```
##########
docs/docs/en/guide/project/project-list.md:
##########
@@ -1,18 +1,29 @@
-# Project Management
+# Project
+
+This page describes details regarding Project screen in Apache DolphinScheduler. Here, you will see all the functions which can be handled in this screen. The following table explains commonly used terms in Apache DolphinScheduler:
+
+| Glossary | |
+| ------ | -------- |
+| DAG | Tasks in a workflow are assembled in form of Directed Acyclic Graph (DAG). A topological traversal is performed from nodes with zero degrees of entry until there are no subsequent nodes. |
+| Workflow Definition | Visualization formed by dragging task nodes and establishing task node associations (DAG). |
+| Workflow Instance | Instantiation of the workflow definition, which can be generated by manual start or scheduled scheduling. Each time the process definition runs, a workflow instance is generated. |
+| Workflow Relation | Shows dynamic status of all the workflows in a project. |
+| Task | Task is a discrete action in a Workflow. Apache DolphinScheduler supports SHELL, SQL, SUB_PROCESS (sub-process), PROCEDURE, MR, SPARK, PYTHON, DEPENDENT ( depends), and plans to support dynamic plug-in expansion, (SUB_PROCESS). It is also a separate process definition that can be started and executed separately. |
+| Task Instance | Instantiation of the task node in the process definition, which identifies the specific task execution status. |
## Create Project
-- Click "Project Management" to enter the project management page, click the "Create Project" button, enter the project name, project description, and click "Submit" to create a new project.
+- Click "`Project Management`" to enter the project management page, click the "`Create Project`" button, enter the project name, project description, and click "Submit" to create a new project.
Review Comment:
```suggestion
- Click `Project Management` to enter the project management page, click the `Create Project` button, enter the project name, project description, and click "Submit" to create a new project.
```
##########
docs/docs/en/guide/project/workflow-instance.md:
##########
@@ -22,21 +22,21 @@
## View Task History
-- Click Project Management -> Workflow -> Workflow Instance, enter the workflow instance page, and click the workflow name to enter the workflow DAG page;
-- Double-click the task node, as shown in the figure below, click "View History" to jump to the task instance page, and display a list of task instances running by the workflow instance
+- Click `Project Management -> Workflow -> Workflow Instance`, enter the workflow instance page, and click the workflow name to enter the workflow DAG page;
+- Double-click the task node, as shown in the figure below, click "`View History`" to jump to the task instance page, and display a list of task instances running by the workflow instance.
Review Comment:
```suggestion
- Double-click the task node, as shown in the figure below, click `View History` to jump to the task instance page, and display a list of task instances running by the workflow instance.
```
##########
docs/docs/en/guide/project/task-instance.md:
##########
@@ -1,9 +1,9 @@
## Task Instance
-- Click Project Management -> Workflow -> Task Instance. Enter the task instance page, as shown in the figure below, click workflow instance name, you can jump to the workflow instance DAG chart to view the task status.
+- Click `Project Management -> Workflow -> Task Instance`. Enter the `Task Instance` page, as shown in the figure below, click workflow instance name, you can jump to the workflow instance DAG chart to view the task status.
-- View log：Click the "view log" button in the operation column to view task execution log.
+- View log：Click the "`View Log`" button in the operation column to view task execution log.
Review Comment:
```suggestion
- View log: Click the `View Log` button in the operation column to view task execution log.
```
--
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