You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by zk...@apache.org on 2022/11/16 09:26:44 UTC
[incubator-devlake-website] branch main updated: docs: update wordings in webhook
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 53aafef40 docs: update wordings in webhook
53aafef40 is described below
commit 53aafef40fe74bed04386e1ae3900df5c3ab432a
Author: Startrekzky <ka...@merico.dev>
AuthorDate: Wed Nov 16 17:11:05 2022 +0800
docs: update wordings in webhook
---
docs/Plugins/webhook.md | 8 ++++----
docs/UserManuals/ConfigUI/webhook.md | 10 +++++-----
2 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/docs/Plugins/webhook.md b/docs/Plugins/webhook.md
index 509babef1..44de68b87 100644
--- a/docs/Plugins/webhook.md
+++ b/docs/Plugins/webhook.md
@@ -6,11 +6,11 @@ description: >
## Overview
-An Incoming Webhook allows users to actively push data to DevLake. It's particularly useful when DevLake is missing the plugin that pulls data from your DevOps tool.
+Incoming Webhooks are your solution to bring data to Apache DevLake when there isn't a specific plugin ready for your DevOps tool. An Incoming Webhook allows users to actively push data to DevLake.
-When you create an Incoming Webhook within DevLake, DevLake generates a unique URL. You can post JSON payloads to this URL to push data to DevLake.
+When you create an Incoming Webhook within DevLake, DevLake generates a unique URL. You can then post JSON payloads to this URL to push data directly to your DevLake instance.
-As of v0.14.0, users can push incidents and deployments required by DORA metrics to DevLake via Incoming Webhooks.
+In v0.14+, users can push "incidents" and "deployments" required by DORA metrics to DevLake via Incoming Webhooks.
## Creating webhooks in DevLake
@@ -78,7 +78,7 @@ Read more in [Swagger](https://sample-url.com/api/swagger/index.html#/plugins%2F
#### Deployment - A real-world example in CircleCI
-The following demo shows how to post "deployments" to DevLake from CircleCI. In this example, the CircleCI job 'deploy' is used to do deployments.
+The following demo shows how to post "deployments" to DevLake from CircleCI. In this example, the CircleCI job 'deploy' is used to manage deployments.
```
diff --git a/docs/UserManuals/ConfigUI/webhook.md b/docs/UserManuals/ConfigUI/webhook.md
index 7b47e9013..42ba628a0 100644
--- a/docs/UserManuals/ConfigUI/webhook.md
+++ b/docs/UserManuals/ConfigUI/webhook.md
@@ -1,19 +1,19 @@
---
-title: "Configuring Webhook"
+title: "Configuring Incoming Webhook"
sidebar_position: 7
description: Config UI instruction for Webhook
---
-Visit config-ui via the Domain Name or IP Address and Port,
+Visit the config-ui via the Domain Name or IP Address and Port,
-### Add a new webhook
+### Add a new incoming webhook
#### 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.
+We recommend that you give your webhook connection a unique name so that you can identify and manage where you have used it later.
### 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.
+After clicking on "Generate POST URL", you will find four webhook URLs. Copy the ones that suit your usage into your CI or issue-tracking systems. You can always come back to the webhook page to copy the URLs later on.
