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


##########
docs/Plugins/webhook.md:
##########
@@ -172,10 +180,10 @@ curl 
http://127.0.0.1:4000/api/plugins/webhook/1/cicd_pipeline/A123/finish -X 'P
 
 Read more in Swagger: 
http://localhost:4000/api/swagger/index.html#/plugins%2Fwebhook/post_plugins_webhook__connectionId_issues.
 
 
-### Sample Config in CircleCi
+### Sample Config in CircleCI
 
-First, we need to know that CircleCi has three entities: pipeline, workflow, 
and job, and the entity workflow is the entity task in DevLake. 
-Second, we must get pipelines and task data from the build machine. In 
CircleCi, the data define in env, and we can get it by $CIRCLE_WORKFLOW_JOB_ID 
and so on. So we can write config to send task data in each workflow and send 
the close pipeline request in the last workflow.
+CircleCI pipelines are the highest-level unit of work. Pipelines include your 
workflows, which coordinate your jobs. The following demo regard CircleCI 
workflow as the entity task in DevLake.
+In CircleCI, the data defined in env describe build machine, pipelines and 
tasks , sucs as `$CIRCLE_WORKFLOW_JOB_ID`, etc. So Write config to send task 
data read from env in each workflow and send the close pipeline request in the 
last workflow.
 

Review Comment:
   Wording/semantics fix:
   
   In CircleCI, the data defined in _env_ describe the build machine, pipelines 
and tasks (e.g. `$CIRCLE_WORKFLOW_JOB_ID`), etc. You will need to add config to 
send task data, read from the _env_, for each workflow, and to send the _close 
pipeline_ request in the last 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.

To unsubscribe, e-mail: [email protected]

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

Reply via email to