Browse Source

[doc] Modified project doc. (#10711)

sneh-wha 2 years ago
parent
commit
423cc5b9be

+ 16 - 5
docs/docs/en/guide/project/project-list.md

@@ -1,8 +1,19 @@
-# 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.
 
 ![project-list](../../../../img/new_ui/dev/project/project-list.png)
 
@@ -10,9 +21,9 @@
 
 - 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. The introduction for those metrics:
 
-- Task status statistics: within the specified time range, count the number of task instances status as successful submission, running, ready to pause, pause, ready to stop, stop, failure, success, need fault tolerance, kill and waiting threads
-- Process status statistics: within the specified time range, count the number of workflow instances status as submission success, running, ready to pause, pause, ready to stop, stop, failure, success, need fault tolerance, kill and waiting threads
-- Workflow definition statistics: count the workflow definitions created by this user and granted by the administrator
+- Task status statistics: Within the specified time range, count the number of task instances status as successful submission, running, ready to pause, pause, ready to stop, stop, failure, success, need fault tolerance, kill and waiting threads
+- Process status statistics: Within the specified time range, count the number of workflow instances status as submission success, running, ready to pause, pause, ready to stop, stop, failure, success, need fault tolerance, kill and waiting threads
+- Workflow definition statistics: Count the workflow definitions created by this user and granted by the administrator
 
 ![project-overview](../../../../img/new_ui/dev/project/project-overview.png)
 

+ 2 - 2
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.
 
 ![task-instance](../../../../img/new_ui/dev/project/task-instance.png)
 
-- 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.
 
 ![task-log](../../../../img/new_ui/dev/project/task-log.png)

File diff suppressed because it is too large
+ 29 - 29
docs/docs/en/guide/project/workflow-definition.md


+ 5 - 5
docs/docs/en/guide/project/workflow-instance.md

@@ -2,7 +2,7 @@
 
 ## View Workflow Instance
 
-- Click Project Management -> Workflow -> Workflow Instance, enter the Workflow Instance page, as shown in the figure below:
+- Click `Project Management -> Workflow -> Workflow Instance`, enter the Workflow Instance page, as shown in the figure below:
 
 ![workflow-instance](../../../../img/new_ui/dev/project/workflow-instance.png)
 
@@ -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.
 
 ![instance-history](../../../../img/new_ui/dev/project/instance-history.png)
 
 ## View Operation Parameters
 
-- Click Project Management -> Workflow -> Workflow Instance, enter the workflow instance page, and click the workflow name to enter the workflow DAG page;
+- Click `Project Management -> Workflow -> Workflow Instance`, enter the workflow instance page, and click the workflow name to enter the workflow DAG page;
 - Click the icon in the upper left corner <img src="../../../../img/run_params_button.png" width="35"/>,View the startup parameters of the workflow instance; click the icon <img src="../../../../img/global_param.png" width="35"/>,View the global and local parameters of the workflow instance, as shown in the following figure:
 
 ![instance-parameter](../../../../img/new_ui/dev/project/instance-parameter.png)
 
 ## Workflow Instance Operation Function
 
-Click Project Management -> Workflow -> Workflow Instance, enter the workflow instance page, as shown in the figure below:
+Click `Project Management -> Workflow -> Workflow Instance`, enter the workflow instance page, as shown in the figure below:
 
 ![workflow-instance](../../../../img/new_ui/dev/project/workflow-instance.png)
 

+ 3 - 0
docs/docs/en/guide/project/workflow-relation.md

@@ -0,0 +1,3 @@
+Workflow Relation screen shows all the existing workflows in a project and their status.
+
+![](../../../../img/new_ui/dev/project/work-relation.png)

BIN
docs/img/new_ui/dev/project/work-relation.png