Check the format of the official website and modify it (#614)

* Fix English document formatting

Author: binbinCheng

community/development-specification/commit-message.md

@@ -4,22 +4,22 @@ sidebar_position: 2
 ---
 >This article is quoted from https://dolphinscheduler.apache.org/en-us/docs/dev/user_doc/contribute/join/commit-message.html
 
-### Preface
+### 1.Preface
 
 A good commit message can help other developers (or future developers) quickly understand the context of related changes, and can also help project managers determine whether the commit is suitable for inclusion in the release. But when we checked the commit logs of many open source projects, we found an interesting problem. Some developers have very good code quality, but the commit message record is rather confusing. When other contributors or learners are viewing the code, it can’t be intuitively understood through commit log.
 The purpose of the changes before and after the submission, as Peter Hutterer said：Re-establishing the context of a piece of code is wasteful. We can’t avoid it completely, so our efforts should go to reducing it as much as possible. Commit messages can do exactly that and as a result, a commit message shows whether a developer is a good collaborator. Therefore, DolphinScheduler developed the protocol in conjunction with other communities and official Apache documents.
 
-### Commit Message RIP
+### 2.Commit Message RIP
 
-#### 1：Clearly modify the content
+#### 2.1 Clearly modify the content
 
 A commit message should clearly state what issues (bug fixes, function enhancements, etc.) the submission solves, so that other developers can better track the issues and clarify the optimization during the version iteration process.
 
-#### 2：Associate the corresponding Pull Request or Issue
+#### 2.2 Associate the corresponding Pull Request or Issue
 
 When our changes are large, the commit message should best be associated with the relevant Issue or Pull Request on GitHub, so that our developers can quickly understand the context of the code submission through the associated information when reviewing the code. If the current commit is for an issue, then the issue can be closed in the Footer section.
 
-#### 3：Unified format
+#### 2.3 Unified format
 
 The formatted CommitMessage can help provide more historical information for quick browsing, and it can also generate a Change Log directly from commit.
 
@@ -89,7 +89,7 @@ If the current commit is for a certain issue, you can close the issue in the Foo
 This closes #001
 ```
 
-### Reference documents
+### 3.Reference documents
 
 [Dolphinscheduler Commit Message](https://dolphinscheduler.apache.org/zh-cn/docs/dev/user_doc/contribute/join/commit-message.html)
 

community/development-specification/how-to-write-unit-test-code.md

@@ -3,7 +3,7 @@ title: How to Write Unit Test Code
 sidebar_position: 10
 ---
 
-## Frame Selection
+## 1.Frame Selection
 
 Junit5 + mockito + Jacobo + H2 local database
 
@@ -13,7 +13,7 @@ Idea enhancement plugin
 - Create the allnewset object and set the default value for allnewset
 - The association mapping between mybatisx DAO and mapper is easy to view
 
-### Configure the Template of JUnit in Idea
+### 1.1 Configure the Template of JUnit in Idea
 
 ```properties
 
@@ -136,9 +136,9 @@ public class $testClass {
 
 
 
-## Unit Test Criteria
+## 2.Unit Test Criteria
 
-### Catalogue And Naming Citeria
+### 2.1 Catalogue And Naming Citeria
 
 - 1. Unit test code directory
      It must be written in the following project directory: src/test/java. It is not allowed to write in the business code directory.  
@@ -156,7 +156,7 @@ public class $testClass {
 - 4. Specification for naming and defining test cases: use test as the prefix of method names
      The naming rule of test cases is: test + method name. Avoid using names that have no meaning in test1 and test2. Secondly, necessary function and method annotations are required.
 
-### Unit Coding Specifications
+### 2.2 Unit Coding Specifications
 
 - 1. System is not allowed to be used in unit test Out for human flesh verification, or if judgment for verification (log can be used for Key log output). Assertion assert must be used for verification.
 
@@ -173,7 +173,7 @@ public class $testClass {
 - 5. For unit testing, it is necessary to ensure that the test granularity is small enough to help accurately locate the problem. Single test granularity is generally at the method level (very few scenarios such as tool classes or enumeration classes can be at the class level).  
      Note: only with small test granularity can we locate the error location as soon as possible. Single test is not responsible for checking cross class or cross system interaction logic, which is the field of integration testing.
 
-## Use of Assertions    
+## 3.Use of Assertions    
 
     The result verification of all test cases must use the assertion pattern     
         use Assertions.assertEquals
@@ -185,7 +185,7 @@ public class $testClass {
         Assertions.assertThat(actualObject).usingRecursiveComparison().isEqualTo(expectedObject);
 
 
-### Junit5 General Assertion
+### 3.1 Junit5 General Assertion
 
 | Method | description    | remarks |
 |--------|-------------|-------------|
@@ -197,7 +197,7 @@ public class $testClass {
 |AssertNotNull | judge whether the given object reference is not null|        | 
 |Assert all | multiple judgment logics are processed together. As long as one error is reported, the overall test will fail|        | 
 
-### Junit5 Combined Assertion and Exception Assertion
+### 3.2 Junit5 Combined Assertion and Exception Assertion
 
 **Composite assertion**
 The assertall method can process multiple judgment logics together. As long as one error is reported, the overall test will fail:
@@ -230,7 +230,7 @@ Example:
     }
   ```
 
-### Assertion Usage Criteria
+### 3.3 Assertion Usage Criteria
 
 **Object instance equality assertion**
 
@@ -264,7 +264,7 @@ assertEquals(2, jobRespProtocolArrayList.size());
 assertTrue(jobRespProtocolArrayList.stream(). anyMatch(statusPrecate));
 ```
 
-## Mock simulation return data
+## 4.Mock simulation return data
 
 Sometimes we just test some apis or service modules, where the service or dao returns null values for some methods by default, but if the logic includes the judgment or secondary value of the returned null object, it is to throw some exceptions
 
@@ -299,9 +299,9 @@ Example of mock simulation data:
         .thenReturn(pageInfo);
 ```
 
-## Compilation of Unit Test
+## 5.Compilation of Unit Test
 
-### Class Division
+### 5.1 Class Division
 
 It can be roughly classified according to the major functions of the class
 
@@ -314,7 +314,7 @@ It can be roughly classified according to the major functions of the class
 -Entity class is used for DB interaction and parameter VO object and other entity classes processed by methods (if there are other user-defined functions besides normal get set, unit test is required)
 
 
-### Unit Test of Controller class
+### 5.2 Unit Test of Controller class
 Using mockmvc
 
 It mainly verifies the requestmethod method of interface request, basic parameters and expected return results.  
@@ -350,10 +350,10 @@ Main scenarios: scenarios with and without unnecessary parameters are abnormal
 
 ```
 
-### Unit Test of Server class
+### 5.3 Unit Test of Server class
    //todo
 
-### Unit Test of Dao class
+### 5.4 Unit Test of Dao class
 
 Use H2 database, application. In the configuration file In properties, you need to configure the basic information of H2 database and the relevant path information of mybatis  
 

community/development-specification/license.md

@@ -9,7 +9,7 @@ sidebar_position: 0.1
 The open source projects under the ASF (Apache Foundation) have extremely strict requirements for the license. When you contribute code to Linkis, you must follow the Apache rules. In order to avoid the contributors wasting too much time on the license,
 This article will explain the ASF-License and how to avoid the license risk when participating in the Linkis project development.
 
-## License file directory description
+## 1.License file directory description
 
 License related can be divided into 3 parts
 - The main scenarios that need to be paid attention to are: in the project source code, the resources are directly included in the project (such as the direct use of video files, sample files, code JAVA of other projects, additions, icons, audio sources) and other files, and modifications made on the basis )
@@ -49,7 +49,7 @@ License related can be divided into 3 parts
 ````
 
 
-## How to legally use third-party open source software on Linkis
+## 2.How to legally use third-party open source software on Linkis
 
 When the code you submit has the following scenarios:
 
@@ -62,7 +62,7 @@ When the code you submit has the following scenarios:
 We need to know the NOTICE/LICENSE of the files introduced by our project or jar dependencies, (most open source projects will have NOTICE files), these must be reflected in our project. In Apache's words, "Work" shall be mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a
 copyright notice that is included in or attached to the work.
 
-### Example Scenario 1
+### 2.1 Example Scenario 1
 For example, the third-party file `linkis-engineconn-plugins/python/src/main/py4j/py4j-0.10.7-src.zip` is introduced into the source code
 
 Find the source branch of the version corresponding to py4j-0.10.7-src.zip, if there is no `LICENSE/NOTICE` file in the corresponding version branch, select the main branch
@@ -74,7 +74,7 @@ The license information of `py4j-0.10.7-src.zip` needs to be specified in the `l
 The detailed license.txt file corresponding to `py4j-0.10.7-src.zip` is placed in the same level directory `linkis-engineconn-plugins/python/src/main/py4j/LICENSE-py4j-0.10 .7-src.txt`
 Since https://github.com/bartdag/py4j/tree/0.10.7/py4j-python does not have a NOTICE file, there is no need to append to the `linkis/NOTICE` file.
 
-### Example Scene 2
+### 2.2 Example Scene 2
 
 The compilation of the project depends on `org.apache.ant:ant:1.9.1`, and ant-1.9.1.jar will be compiled and installed in the final package `target/apache-linkis-xxx-incubating-bin/linkis-package/lib `medium
 You can decompress ant-1.9.1.jar and extract the LICENSE/NOTICE file from the jar package. If not, you need to find the corresponding version source code
@@ -89,7 +89,7 @@ The detailed notice.txt corresponding to `ant-1.9.1.jar` is appended to the `NOT
 
 Regarding the specific open source protocol usage protocols, I will not introduce them one by one here. If you are interested, you can check them yourself.
 
-## License detection rules
+## 3.License detection rules
 We build a license-check script for our own project to ensure that we can avoid license problems as soon as we use it.
 
 When we need to add new Jars or other external resources, we need to follow these steps:
@@ -125,7 +125,7 @@ In this case, we will get the error message of check dependency license fail in
 Follow the steps to add jar to add it.
 
 
-## Appendix
+## 4.Appendix
 Attachment: Mail format of new jar
 ````
 [VOTE][New/Remove Jar] jetcd-core(registry plugin support etcd3 )
@@ -160,6 +160,6 @@ https://mvnrepository.com/artifact/io.etcd/jetcd-core
 https://mvnrepository.com/artifact/io.etcd/jetcd-launcher
 ````
 
-## Reference articles
+## 5.Reference articles
 * [COMMUNITY-LED DEVELOPMENT "THE APACHE WAY"](https://apache.org/dev/licensing-howto.html)
 * [ASF 3RD PARTY LICENSE POLICY](https://apache.org/legal/resolved.html)

community/development-specification/mapper-xml.md

@@ -5,7 +5,7 @@ sidebar_position: 10
 
 > Contributor contributes new data tables to Apache Linkis. When writing Mapper XML, the following specifications must be followed for development.
 
-## Basically follow the specifications
+## 1.Basically follow the specifications
 - In mapper.xml namespace is equal to java interface address  
 - The method name in the java interface is the same as the id of the statement in XML  
 - The input parameter type of the method in the java interface is the same as the type specified by the parameterType of the statement in XML
@@ -16,7 +16,7 @@ sidebar_position: 10
 - For placeholders, use #{name} instead of ${name}. Fuzzy query can use CONCAT('%',#{sname},'%')
 - For sql statement writing, no annotation method is used, and it is uniformly written in the XML file
 
-## Method name specification
+## 2.Method name specification
 
 |Method Name|Description|Core Points|Recommendations|
 |:---- |:--- |:--- |:--- |
@@ -28,9 +28,9 @@ sidebar_position: 10
 |queryListByParam | Query data list according to input conditions | Multi-parameter query list | |
 |queryCountByParam | The total number of queries based on input conditions | The number of multi-parameter queries | |
 
-## parameterType specification
+## 3.parameterType specification
 The java interface must contain @Param, and the XML can not contain parameterType
-### basic type
+### 3.1 basic type
 ````java
 // java interface
 User selectUserById(@Param("id") Integer id);
@@ -41,7 +41,7 @@ User selectUserById(@Param("id") Integer id);
 	where id = #{id}
 </select>
 ````
-### Collection type
+### 3.2 Collection type
 ````java
 // java interface
 List<User> userListByIds(@Param("ids") List<Integer> ids);
@@ -55,7 +55,7 @@ List<User> userListByIds(@Param("ids") List<Integer> ids);
 		</foreach>
 </select>
 ````
-### Map type
+### 3.3 Map type
 ````java
 // java interface
 User queryByParams(@Param("map") Map<String, Object> parasms);
@@ -66,7 +66,7 @@ User queryByParams(@Param("map") Map<String, Object> parasms);
 	where id = #{map.id} and name = #{map.name}
 </select>
 ````
-### Entity Type
+### 3.4 Entity Type
 ````java
 // java interface
 User queryByUser(@Param("user") User user);
@@ -77,7 +77,7 @@ User queryByUser(@Param("user") User user);
 	where id = #{user.id} and name = #{user.name}
 </select>
 ````
-### Multiple parameter types
+### 3.5 Multiple parameter types
 ````java
 // java interface
 User queryByIdAndName(@Param("id") Integer id, @Param("name") String name);
@@ -88,7 +88,7 @@ User queryByIdAndName(@Param("id") Integer id, @Param("name") String name);
 	where id = #{id} and name = #{name}
 </select>
 ````
-## XML file writing example
+## 4.XML file writing example
 Use spaces and indentation reasonably to enhance readability. Examples of various types of SQL statements are as follows
 ```sql
 <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

community/how-to-ask-for-help.md

@@ -19,9 +19,9 @@ step2 Copy the template content
 -->
 
 
-## Method 1 Github-issue ask questions (recommended)
+## 1.Method 1 Github-issue ask questions (recommended)
 
-### Precautions
+### 1.1 Precautions
 :::caution note
 - Please ask questions in a standardized format, so that the community students can answer them. After asking questions, please continue to pay attention to your questions.
 - Please note that in addition to screenshots, please <font color="red">paste the error log into </font> in text form, only the problem of the picture log will not be given priority to answer
@@ -30,7 +30,7 @@ step2 Copy the template content
 - If it is an error during the running phase, please attach a screenshot of the Eureka registry service list
 :::
 
-### Attachment & image upload
+### 1.2 Attachment & image upload
 If you want to attach a file attachment, drag and drop it into the comment box. Or click the bar at the bottom of the comment box to browse, select, and add files from your computer.
 ![img](/Images/community/upload-file.png)
 
@@ -41,7 +41,7 @@ In many browsers you can copy and paste the image directly into the box
 The log file should not exceed 25MB
 :::
 
-### Completion instructions
+### 2.Completion instructions
 - Entry: https://github.com/apache/incubator-linkis/issues
 
 ** Step1: Enter the issue column, click to create issue **
@@ -66,7 +66,7 @@ The log file should not exceed 25MB
 
 
 
-## Method 2 email consultation
+## 3.Method 2 email consultation
 
 Email Question Process
 

docs/architecture/commons/rpc.md

@@ -3,14 +3,14 @@ title: RPC Module
 sidebar_position: 2
 ---
 
-## 1 Overview
+## 1.Overview
 The call of HTTP interface between Feign-based microservices can only satisfy a simple A microservice instance that randomly selects a service instance in B microservices according to simple rules, and if this B microservice instance wants to asynchronously return information To the caller, it is simply impossible to achieve.
 At the same time, because Feign only supports simple service selection rules, it cannot forward the request to the specified microservice instance, and cannot broadcast a request to all instances of the recipient microservice.
 
 ## 2. Architecture description
-## 2.1. Architecture design diagram
+### 2.1 Architecture design diagram
 ![Linkis RPC architecture diagram](/Images/Architecture/Commons/linkis-rpc.png)
-## 2.2. Module description
+### 2.2 Module description
 The functions of the main modules are introduced as follows:
 * Eureka: service registration center, user management service, service discovery.
 * Sender: Service request interface, the sender uses Sender to request service from the receiver.

docs/architecture/commons/variable.md

@@ -4,9 +4,9 @@ sidebar_position: 1
 ---
 
 ## 1. General
-### Requirements Background
+### 1.1 Requirements Background
      Users want to be able to define some common variables when writing code and then replace them during execution. For example, users run the same sql in batches every day, and need to specify the partition time of the previous day. If based on sql It will be more complicated to write if the system provides a variable of run_date which will be very convenient to use.
-### Target
+### 1.2 Target
 1. Support variable substitution of task code
 2. Support custom variables, support users to define custom variables in scripts and task parameters submitted to Linkis, support simple +, - and other calculations
 3. Preset system variables: run_date, run_month, run_today and other system variables
@@ -19,7 +19,7 @@ sidebar_position: 1
 
 ![var_arc](/Images/Architecture/Commons/var_arc.png)
 
-### 3 Function introduction
+## 3.Function introduction
      The variable types supported by Linkis are divided into custom variables and system built-in variables. The internal variables are predefined by Linkis and can be used directly. Then different variable types support different calculation formats: String supports +, integer decimal supports +-*/, date supports +-.
 
 ### 3.1 Built-in variables

docs/architecture/computation-governance-services/job-submission-preparation-and-execution-process.md

@@ -87,7 +87,7 @@ The task status is now queued
 
 ### 2.2 Job preparation stage
     Entrance's scheduler will generate different consumers to consume tasks according to the Label in the Job. When the task is consumed and modified to Running, it will enter the preparation state, and the task will be prepared after the corresponding task. Phase begins. It mainly involves the following services: Entrance, LinkisMaster, EnginepluginServer, EngineConnManager, and EngineConn. The following services will be introduced separately.
-### 2.2.1 Entrance steps:
+#### 2.2.1 Entrance steps:
 1. The consumer (FIFOUserConsumer) consumes the supported concurrent number configured by the corresponding tag, and schedules the task consumption to the Orchestrator for execution
 2. First, Orchestrator arranges the submitted tasks. For ordinary hive and Spark single-engine tasks, it is mainly task parsing, label checking and verification. For multi-data source mixed computing scenarios, different tasks will be split and submitted to Different data sources for execution, etc.
 3. In the preparation phase, another important thing for the Orchestrator is to request the LinkisMaster to obtain the EngineConn for executing the task. If LinkisMaster has a corresponding EngineConn that can be reused, it will return directly, if not, create an EngineConn.
@@ -110,7 +110,7 @@ DefaultCodeExecTaskExecutorManager: EngineConn responsible for managing code typ
 ComputationEngineConnManager: Responsible for LinkisMaster to connect, request and release ENgineConn
 ````
 
-### 2.2.2 LinkisMaster steps:
+#### 2.2.2 LinkisMaster steps:
 
 1. LinkisMaster receives the request EngineConn request from the Entrance service for processing
 2. Determine if there is an EngineConn that can be reused by the corresponding Label, and return directly if there is