You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by he...@apache.org on 2022/10/11 05:58:54 UTC
[incubator-devlake-website] 02/03: docs: update add a new webhook section
This is an automated email from the ASF dual-hosted git repository.
hez pushed a commit to branch update-webhook-plugin-doc
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
commit 140804aa0f7315315a0d4912345c68ba6d499738
Author: Hezheng Yin <he...@merico.dev>
AuthorDate: Mon Oct 10 19:52:44 2022 -0700
docs: update add a new webhook section
---
docs/Plugins/webhook.md | 9 +++------
docs/UserManuals/ConfigUI/webhook.md | 12 ++++++------
2 files changed, 9 insertions(+), 12 deletions(-)
diff --git a/docs/Plugins/webhook.md b/docs/Plugins/webhook.md
index 17627796e..8b1f86e3c 100644
--- a/docs/Plugins/webhook.md
+++ b/docs/Plugins/webhook.md
@@ -14,19 +14,16 @@ As of v0.14.0, users can push incidents and deployments data required by DORA me
## Creating webhooks in DevLake
-Configuring webhooks via the Config UI.
-
-First, you can create a webhook connection from the Integration page.
+### Add a new webhook
+To add a new webhook, go to "Data Connections" page in config-ui and select "Issue/Deployment Incoming/Webhook".
We recommand that you give your webhook connection a unique name so that you can identify and manage where you have used it later.
-After cicking on "Generate POST URL", you will find four webhook URLs. Copy the ones that suits your usage into your CI or issue tracking systems. You can always come back to the webhook page to copy the URLs later on.
+After clicking on "Generate POST URL", you will find four webhook URLs. Copy the ones that suits your usage into your CI or issue tracking systems. You can always come back to the webhook page to copy the URLs later on.
-
-
## Incident / Issue
If you want to collect issue or incident data from your system, you can use the two webhooks for issues.
diff --git a/docs/UserManuals/ConfigUI/webhook.md b/docs/UserManuals/ConfigUI/webhook.md
index a879e3117..b7fb984cc 100644
--- a/docs/UserManuals/ConfigUI/webhook.md
+++ b/docs/UserManuals/ConfigUI/webhook.md
@@ -4,16 +4,16 @@ sidebar_position: 7
description: Config UI instruction for Webhook
---
-Visit config-ui: `http://localhost:4000`.
-### Add and Update Data Connections
+Visit config-ui: `http://localhost:4000` if you deployed via docker-compose.
+
+### Add a new webhook
-#### Connection Name
-Name your connection.
+#### Webhook name
We recommand that you give your webhook connection a unique name so that you can identify and manage where you have used it later.
-### Use Webhook
-After cicking on "Generate POST URL", you will find four webhook URLs. Copy the ones that suits your usage into your CI or issue tracking systems. You can always come back to the webhook page to copy the URLs later on.
+### Use Webhooks
+After clicking on "Generate POST URL", you will find four webhook URLs. Copy the ones that suits your usage into your CI or issue tracking systems. You can always come back to the webhook page to copy the URLs later on.
