This is an automated email from the ASF dual-hosted git repository.
zky pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
The following commit(s) were added to refs/heads/main by this push:
new a60e119e84 update webhook docs to reflect relationship between deploy
and incide… (#645)
a60e119e84 is described below
commit a60e119e844f29244bfea690634730cf105ea55f
Author: Nathan Nicholson <[email protected]>
AuthorDate: Fri Dec 29 05:10:40 2023 -0600
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]>
---
docs/Plugins/webhook.md | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/docs/Plugins/webhook.md b/docs/Plugins/webhook.md
index 328223d2a6..3b35d4ca74 100644
--- 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 th [...]
+
+Diagram of the relationship between incidents and deployments:
+
+
+
## Entities
Check out the [Incoming Webhooks
entities](/Overview/SupportedDataSources.md#data-collection-scope-by-each-plugin)
collected by this plugin.
