update webhook docs to reflect relationship between deploy and incide… (

#645) * update webhook docs to reflect relationship between deploy and incident reporting Signed-off-by: Nathan Nicholson <[email protected]> * changing source of image to existing CFR image Signed-off-by: Nathan Nicholson <[email protected]> * Updated wording Signed-off-by: Nathan Nicholson <[email protected]> --------- Signed-off-by: Nathan Nicholson <[email protected]>
apache · Dec 29, 2023 · a60e119 · a60e119
1 parent 1e5c492
commit a60e119
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/docs/Plugins/webhook.md b/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 on a project will be related to the last deployment on the project with a timestamp that is before the incident's timestamp. This is true regardless of the source of incidents or deployments.
+
+Diagram of the relationship between incidents and deployments:
+
+![Change Failure Reporting](/img/Metrics/cfr-definition.png)
+
 ## Entities
 
 Check out the [Incoming Webhooks entities](/Overview/SupportedDataSources.md#data-collection-scope-by-each-plugin) collected by this plugin.