Startrekzky commented on code in PR #645: URL: https://github.com/apache/incubator-devlake-website/pull/645#discussion_r1333803159
########## docs/Plugins/webhook.md: ########## @@ -12,6 +12,12 @@ When you create an Incoming Webhook within DevLake, DevLake generates a unique U In v0.14+, users can push "incidents" and "deployments" required by DORA metrics to DevLake via Incoming Webhooks. +Webhooks are meant to be used at the lowest level that you want to relate incidents with deployments. For example, if you want to relate incidents at the individual service level, you will need a webhook per service. If you wish to relate incidents at the product level, you will need a webhook for the product. This is because incidents that are reported to the webhook will be related to the last deployment that was reported to the webhook with a timestamp that is before the incident's timestamp. + +Diagram of the relationship between incidents and deployments: + + Review Comment: Hi, you don't need to add a new image file. You can re-use this picture referenced in the CFR doc https://devlake.apache.org/docs/Metrics/CFR#how-is-it-calculated. ########## docs/Plugins/webhook.md: ########## @@ -12,6 +12,12 @@ When you create an Incoming Webhook within DevLake, DevLake generates a unique U In v0.14+, users can push "incidents" and "deployments" required by DORA metrics to DevLake via Incoming Webhooks. +Webhooks are meant to be used at the lowest level that you want to relate incidents with deployments. For example, if you want to relate incidents at the individual service level, you will need a webhook per service. If you wish to relate incidents at the product level, you will need a webhook for the product. This is because incidents that are reported to the webhook will be related to the last deployment that was reported to the webhook with a timestamp that is before the incident's timestamp. Review Comment: > This is because incidents that are reported to the webhook will be related to the last deployment that was reported to the webhook with a timestamp that is before the incident's timestamp. The incidents will be related to the `last deployment` no matter the deployment is pushed by webhook or collected by plugins with CI/CD entities. E.g. GitHub, GitLab, Jenkins, Bamboo, etc. Likewise, the `incidents` used to relate to the deployments are not limited to those from the webhook, incidents collected from Jira, PagerDuty and etc. also count. So, I guess it's better to paraphrase the wording a little bit. -- 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]
