AhahaGe commented on a change in pull request #190:
URL:
https://github.com/apache/incubator-dolphinscheduler-website/pull/190#discussion_r503238613
##########
File path: docs/en-us/1.3.2/user_doc/system-manual.md
##########
@@ -0,0 +1,883 @@
+# System User Manual
+
+## Get started quickly
+
+> Please refer to [Quick Start](quick-start.html)
+
+## Operation guide
+
+### 1. Home
+
+The home page contains task status statistics, process status statistics, and
workflow definition statistics for all projects of the user.
+
+<p align="center">
+<img src="/img/home_en.png" width="80%" />
+</p>
+
+### 2. Project management
+
+#### 2.1 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.
+
+ <p align="center">
+ <img src="/img/create_project_en1.png" width="80%" />
+ </p>
+
+#### 2.2 Project home
+
+- Click the project name link on the project management page to enter the
project home page, as shown in the figure below, the project home page contains
the task status statistics, process status statistics, and workflow definition
statistics of the project.
+ <p align="center">
+ <img src="/img/project_home_en.png" width="80%" />
+ </p>
+
+- Task status statistics: within the specified time range, count the number of
tasks in the task instance as successful submission, running, ready to pause,
pause, ready to stop, stop, failure, success, fault tolerance, kill, and
waiting threads
+- Process status statistics: within the specified time range, count the number
of the status of the workflow instance as submission success, running, ready to
pause, pause, ready to stop, stop, failure, success, fault tolerance, kill, and
waiting threads
+- Workflow definition statistics: Count the workflow definitions created by
users and the workflow definitions granted to this user by the administrator
+
+#### 2.3 Workflow definition
+
+#### <span id=creatDag>2.3.1 Create a workflow definition</span>
+
+- Click Project Management -> Workflow -> Workflow Definition to enter the
workflow definition page, and click the "Create Workflow" button to enter the
**workflow DAG edit** page, as shown in the following figure:
+ <p align="center">
+ <img src="/img/dag5.png" width="80%" />
+ </p>
+- Drag in the toolbar <img src="/img/shell.png" width="35"/> Add a Shell task
to the drawing board, as shown in the figure below:
+ <p align="center">
+ <img src="/img/shell-en.png" width="80%" />
+ </p>
+- **Add parameter settings for shell tasks:**
+
+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 be executed when running the workflow;
+3. Select "Task Priority": When the number of worker threads is insufficient,
high-level tasks will be executed first in the execution queue, and tasks with
the same priority will be executed in the order of first in, first out;
+4. Timeout alarm (not required): Check the timeout alarm, timeout failure, and
fill in the "timeout period". When the task execution time exceeds **timeout
period**, an alert email will be sent and the task timeout fails;
+5. Resources (optional). Resource files are files created or uploaded on 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. Custom parameters (not required), refer to [Custom
Parameters](#UserDefinedParameters);
+7. Click the "Confirm Add" button to save the task settings.
+
+- **Increase the order of task execution:** Click the icon in the upper right
corner <img src="/img/line.png" width="35"/> to connect the task; as shown in
the figure below, task 2 and task 3 are executed in parallel, When task 1 is
executed, tasks 2 and 3 will be executed simultaneously.
+
+ <p align="center">
+ <img src="/img/dag6.png" width="80%" />
+ </p>
+
+- **Delete dependencies:** Click the "arrow" icon in the upper right corner
<img src="/img/arrow.png" width="35"/>, select the connection line, and click
the "Delete" icon in the upper right corner <img src= "/img/delete.png"
width="35"/>, delete dependencies between tasks.
+ <p align="center">
+ <img src="/img/dag7.png" width="80%" />
+ </p>
+
+- **Save workflow definition:** Click the "Save" button, and the "Set DAG
chart name" pop-up box will pop up, as shown in the figure below. Enter the
workflow definition name, workflow definition description, and set global
parameters (optional, refer to [ Custom parameters](#UserDefinedParameters)),
click the "Add" button, and the workflow definition is created successfully.
+ <p align="center">
+ <img src="/img/dag8.png" width="80%" />
+ </p>
+> For other types of tasks, please refer to [Task Node Type and Parameter
Settings](#TaskParamers).
+
+#### 2.3.2 Workflow definition operation function
+
+Click Project Management -> Workflow -> Workflow Definition to enter the
workflow definition page, as shown below:
+
+<p align="center">
+<img src="/img/work_list_en.png" width="80%" />
+</p>
+The operation functions of the workflow definition list are as follows:
+
+- **Edit:** Only "offline" workflow definitions can be edited. Workflow DAG
editing is the same as [Create Workflow Definition](#creatDag).
+- **Online:** When the workflow status is "Offline", the workflow is online.
Only the workflow in the "Online" state can run, but cannot be edited.
+- **Offline:** When the workflow status is "Online", the workflow is offline.
Only the workflow in the "Offline" state can be edited, but not run.
+- **Run:** Only workflow in the online state can run. See [2.3.3 Run
Workflow](#runWorkflow) for the operation steps
+- **Timing:** Timing can only be set in online workflows, and the system
automatically schedules the workflow to run on a regular basis. The status
after creating a timing is "offline", and the timing must be online on the
timing management page to take effect. See [2.3.4 Workflow
Timing](#creatTiming) for timing operation steps.
+- **Timing Management:** The timing management page can be edited,
online/offline, and deleted.
+- **Delete:** Delete the workflow definition.
+- **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:
+ <p align="center">
+ <img src="/img/tree_en.png" width="80%" />
+ </p>
+
+#### <span id=runWorkflow>2.3.3 Run the workflow</span>
+
+- 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"/>，Go online workflow.
Review comment:
Go online workflow -> to online workflow
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
[email protected]
