AhahaGe commented on a change in pull request #190:
URL:
https://github.com/apache/incubator-dolphinscheduler-website/pull/190#discussion_r503249021
##########
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.
+ <p align="center">
+ <img src="/img/work_list_en.png" width="80%" />
+ </p>
+
+- Click the "Run" button to pop up the startup parameter setting pop-up box,
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.
+ <p align="center">
+ <img src="/img/run_work_en.png" width="80%" />
+ </p>
+ <span id=runParamers>Description of workflow operating parameters:</span>
+
+ * Failure strategy: When a task node fails to execute, other parallel
task nodes need to execute the strategy. "Continue" means: after a certain task
fails, other task nodes execute normally; "End" means: terminate all tasks
being executed, and terminate the entire process.
+ * Notification strategy: When the process is over, the process execution
information notification email is sent according to the process status,
including any status is not sent, successful, failed, successful or failed.
+ * Process priority: The priority of process operation, divided into five
levels: highest (HIGHEST), high (HIGH), medium (MEDIUM), low (LOW), and lowest
(LOWEST). When the number of master threads is insufficient, high-level
processes will be executed first in the execution queue, and processes with the
same priority will be executed in a first-in first-out order.
+ * Worker group: The process can only be executed in the specified worker
machine group. The default is Default, which can be executed on any worker.
+ * Notification group: select notification strategy||timeout alarm||when
fault tolerance occurs, process information or email will be sent to all
members in the notification group.
+ * Recipient: Select notification policy||Timeout alarm||When fault
tolerance occurs, process information or alarm email will be sent to the
recipient list.
+ * Cc: Select the notification strategy||Timeout alarm||When fault
tolerance occurs, the process information or warning email will be copied to
the CC list.
+ * Complement: Two modes including serial complement and parallel
complement. Serial complement: within the specified time range, the complement
is executed sequentially from the start date to the end date, and only one
process instance is generated; parallel complement: within the specified time
range, multiple days are complemented at the same time to generate N process
instances.
+ * Complement: Execute the workflow definition of the specified date, you
can select the time range of the complement (currently only supports the
complement for consecutive days), for example, you need to supplement the data
from September 19 to October 16, as shown in the following figure:
+ <p align="center">
+ <img src="/img/complement_en.png" width="80%" />
+ </p>
+
+ > Serial mode: The complement is executed sequentially from September 19 to
October 16, and a process instance is generated on the process instance page;
+
+ > Parallel mode: The tasks from September 19 to October 16 are executed
simultaneously, and 28 process instances are generated on the process instance
page.
+
+#### <span id=creatTiming>2.3.4 Workflow timing</span>
+
+- Create timing: Click Project Management->Workflow->Workflow Definition,
enter the workflow definition page, go online the workflow, click the "timing"
button <img src="/img/timing.png" width="35"/> ,The timing parameter setting
dialog box pops up, as shown in the figure below:
+ <p align="center">
+ <img src="/img/time_schedule_en.png" width="80%" />
+ </p>
+- Choose the start and end time. In the start and end time range, the workflow
is run at regular intervals; not in the start and end time range, no more
regular workflow instances are generated.
+- Add a timing that is executed once every day at 5 AM, as shown in the
following figure:
+ <p align="center">
+ <img src="/img/timer-en.png" width="80%" />
+ </p>
+- Failure strategy, notification strategy, process priority, worker grouping,
notification group, recipient, and CC are the same as [workflow running
parameters](#runParamers).
+- Click the "Create" button to create the timing successfully. At this time,
the timing status is "**Offline**" and the timing needs to be **Online** to
take effect.
+- Timed 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
follows As shown in the figure, the workflow takes 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 takes effect regularly.
```
----------------------------------------------------------------
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]
