keon94 commented on code in PR #246:
URL: 
https://github.com/apache/incubator-devlake-website/pull/246#discussion_r992812992


##########
docs/Plugins/webhook.md:
##########
@@ -100,27 +94,39 @@ Read more in Swagger: 
http://localhost:4000/api/swagger/index.html#/plugins%2Fwe
 
 ## Deployments
 
-Adding pipeline webhook in your deploy shells will help you collect data into 
DevLake.
+If your CI/CD tool isn't already supported by DevLake, you can insert curl 
commands in your CI/CD script to post deployment data to DevLake.
+
+DevLake models CI/CD domain with two entities: Pipelines and Tasks. A pipeline 
has many tasks.
+
+#### Example 1
 
-First, let us know there are two entities: Tasks and Pipelines. A pipeline 
means one build or deployment, and a pipeline may have more than one task.
+Take GitHub Actions as an example, the screenshot below shows a GitHub Actions 
workflow, which consists of 6 jobs including `golangci-lint`, `unit-test`, and 
etc. When DevLake normalizes data from GitHub Actions, it creates the following 
records in the domain layer:
+
+- 1 entry in cicd_pipelines table, corresponds to the GitHub workflow
+- 6 entries in cicd_tasks table, one for each job in the GitHub workflow
 
 
![image](https://user-images.githubusercontent.com/3294100/191319143-ea5e9546-1c6d-4b2a-abba-95375cfdcec3.png)
 
-(Example 1)
+#### Example 2
+
+Then look at Jenkins build history, the screenshot below shows 12 Jenkins 
builds, and no Jenkins stages appeared. When DevLake normalizes data from 
Jenkins build history, it creates the following records in the domain layer:
 
-For example, we can find 6 tasks like `golangci-lint` and `unit-test` in one 
GitHub pipeline.
+- 12 entry in cicd_pipelines table, corresponds to the Jenkins builds
 
 
![image](https://user-images.githubusercontent.com/3294100/191319924-f05c4790-d368-4fe4-8c07-dea43e1dd2f3.png)
+(Image from the Internet)
 
-(Example 2. Image from the Internet)
+#### Example 3
 
-In Example 2, we can find 12 Jenkins pipelines.
+Jenkins build may contain some stage. This screenshot shows 5 Jenkins builds, 
which consists of 1~4 stages including `Build the sudo images for 
installation`, `Basic Test: running from repo with preinstalled libs`, and etc. 
When DevLake normalizes data from Jenkins, it creates the following records in 
the domain layer:
 

Review Comment:
   wording/semantics fix:
   
   Jenkins builds may contain stages. This screenshot shows 5 Jenkins builds, 
which consist of 1~4 stages, including `Build the sudo images for 
installation`, `Basic Test: running from repo with preinstalled libs`, etc. 
When DevLake gets and normalizes data from Jenkins, it creates the following 
records in the domain layer:



-- 
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: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to