You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by "abeizn (via GitHub)" <gi...@apache.org> on 2023/03/03 03:22:14 UTC
[GitHub] [incubator-devlake-website] abeizn opened a new pull request, #454: docs: add webhook usage docs in a project
abeizn opened a new pull request, #454:
URL: https://github.com/apache/incubator-devlake-website/pull/454
### ⚠️ Pre Checklist
> Please complete _ALL_ items in this checklist, and remove before submitting
- [ ] I have `npm run build` and `npm run serve` locally before submitting this PR
- [ ] I have read through the [Contributing](https://devlake.apache.org/community/) Documentation
# Summary
add webhook usage docs in a project
### Does this close any open issues?
related to https://github.com/apache/incubator-devlake/issues/4462
### Screenshots
### Other Information
Any other information that is important to this PR.
--
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: commits-unsubscribe@devlake.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-devlake-website] Startrekzky commented on a diff in pull request #454: docs: add webhook usage docs in a project
Posted by "Startrekzky (via GitHub)" <gi...@apache.org>.
Startrekzky commented on code in PR #454:
URL: https://github.com/apache/incubator-devlake-website/pull/454#discussion_r1124325649
##########
docs/Configuration/webhook.md:
##########
@@ -14,11 +14,17 @@ Go to the 'Data Connections' page. Create a webhook.
We recommend that you give your webhook connection a unique name so that you can identify and manage where you have used it later.
-### Step 2 - Use Webhooks
+### Step 2 - Create webhooks connection
Click on Generate POST URL, and 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.
Review Comment:
Click on `Generate POST URL`, and you will find three webhook URLs.
##########
versioned_docs/version-v0.15/UserManuals/DORA.md:
##########
@@ -64,113 +66,123 @@ Calculating DORA metrics requires three key entities: **changes**, **deployments
In the next section, we'll demonstrate how to configure DevLake to implement DORA metrics for the aforementioned example team.
### Collect GitHub & Jira data via `blueprint`
+
1. Visit the config-ui at `http://localhost:4000`
-2. Create a `blueprint`, let's name it "Blueprint for DORA", add a Jira and a GitHub connection. Click `Next Step`
-
+2. Create a project: `project1`. And then create a `blueprint`, let's name it "Blueprint for DORA", add a Jira and a GitHub connection. Click `Next Step`
+ 
+ 
3. Select Jira boards and GitHub repos to collect, click `Next Step`
-
+ 
4. Click `Add Transformation` to configure for DORA metrics
-
+ 
5. To make it simple, fields with a  label are DORA-related configurations for every data source. Via these fields, you can define what are "incidents" and "deployments" for each data source. After all data connections have been configured, click `Next Step`
+
- This team uses Jira issue types `Crash` and `Incident` as "incident", so choose the two types in field "incident". Jira issues in these two types will be transformed to "incidents" in DevLake.
- This team uses the GitHub action jobs named `deploy` and `build-and-deploy` to deploy, so type in `(?i)deploy` to match these jobs. These jobs will be transformed to "deployments" in DevLake.
- 
-
+ 
+
Note: The following example shows where to find GitHub action jobs. It's easy to mix them up with GitHub workflows.
-
6. Choose sync frequency, click 'Save and Run Now' to start data collection. The time to completion varies by data source and depends on the volume of data.
-
+ 
For more details, please refer to our [blueprint manuals](https://devlake.apache.org/docs/UserManuals/ConfigUI/Tutorial).
### Collect CircleCI data via `webhook`
Using CircleCI as an example, we demonstrate how to actively push data to DevLake using the Webhook approach, in cases where DevLake doesn't have a plugin specific to that tool to pull data from your data source.
-7. Visit "Data Connections" page in config-ui and select "Issue/Deployment Incoming Webhook".
+7. Go to the 'Data Connections' page. Create a webhook.
+
+
Review Comment:
Add indent?
##########
docs/DORA.md:
##########
@@ -5,47 +5,49 @@ description: >
DORA Metrics
---
-
This document describes everything you need to know about DORA, and implementing this powerful and practical framework in DevLake.
## What are DORA metrics?
+
Created six years ago by a team of researchers, DORA stands for "DevOps Research & Assessment" and is the answer to years of research, having examined thousands of teams, seeking a reliable and actionable approach to understanding the performance of software development teams.
DORA has since become a standardized framework focused on the stability and velocity of development processes, one that avoids the more controversial aspects of productivity and individual performance measures.
-There are two key clusters of data inside DORA: Velocity and Stability. The DORA framework is focused on keeping them in context with each other, as a whole, rather than as independent variables, making the data more challenging to misinterpret or abuse.
+There are two key clusters of data inside DORA: Velocity and Stability. The DORA framework is focused on keeping them in context with each other, as a whole, rather than as independent variables, making the data more challenging to misinterpret or abuse.
+
+Within velocity are two core metrics:
-Within velocity are two core metrics:
- [Deployment Frequency](https://devlake.apache.org/docs/Metrics/DeploymentFrequency): Number of successful deployments to production, how rapidly is your team releasing to users?
- [Lead Time for Changes](https://devlake.apache.org/docs/Metrics/LeadTimeForChanges): How long does it take from commit to the code running in production? This is important, as it reflects how quickly your team can respond to user requirements.
Stability is composed of two core metrics:
+
- [Median Time to Restore Service](https://devlake.apache.org/docs/Metrics/MTTR): How long does it take the team to properly recover from a failure once it is identified?
- [Change Failure Rate](https://devlake.apache.org/docs/Metrics/CFR): How often are your deployments causing a failure?
-To make DORA even more actionable, there are well-established benchmarks to determine if you are performing at "Elite", "High", "Medium", or "Low" levels. Inside DevLake, you will find the benchmarking table available to assess and compare your own projects.
+To make DORA even more actionable, there are well-established benchmarks to determine if you are performing at "Elite", "High", "Medium", or "Low" levels. Inside DevLake, you will find the benchmarking table available to assess and compare your own projects.
## Why is DORA important?
-DORA metrics help teams and projects measure and improve software development practices to consistently deliver reliable products, and thus happy users!
+DORA metrics help teams and projects measure and improve software development practices to consistently deliver reliable products, and thus happy users!
## How to implement DORA metrics with Apache DevLake?
You can set up DORA metrics in DevLake in a few steps:
+
- **Install**: [Getting Started](https://devlake.apache.org/docs/GettingStarted)
- **Collect**: Collect data via blueprint
- - In the blueprint, select the data you wish to collect, and make sure you have selected the data required for DORA metrics
- - Configure DORA-related transformation rules to define `deployments` and `incidents`
- - Select a sync frequency for your data, save and run the blueprint.
+ - In the blueprint, select the data you wish to collect, and make sure you have selected the data required for DORA metrics
+ - Configure DORA-related transformation rules to define `deployments` and `incidents`
+ - Select a sync frequency for your data, save and run the blueprint.
- **Report**: DevLake provides a built-in DORA dashboard. See an example screenshot below or check out our [live demo](https://grafana-lake.demo.devlake.io/grafana/d/qNo8_0M4z/dora?orgId=1).
-
+ 
DevLake now supports Jenkins, GitHub Action and GitLabCI as data sources for `deployments` data; Jira, GitHub issues, and TAPD as the sources for `incidents` data; Github PRs, GitLab MRs as the sources for `changes` data.
-If your CI/CD tools are not listed on the [Supported Data Sources](https://devlake.apache.org/docs/SupportedDataSources) page, have no fear! DevLake provides incoming webhooks to push your `deployments` data to DevLake. The webhook configuration doc can be found [here](https://devlake.apache.org/docs/Configuration/webhook/).
-
+If your CI/CD tools are not listed on the [Supported Data Sources](https://devlake.apache.org/docs/next/Overview/SupportedDataSources) page, have no fear! DevLake provides incoming webhooks to push your `deployments` data to DevLake. The webhook configuration doc can be found [here](https://devlake.apache.org/docs/Configuration/webhook/).
Review Comment:
You can't use absolute URL of the next version of docs. You should remove the `/next/` part.
The solution is to use relative URL, then Docusaurus won't throw error and the URL will not break after the doc freeze.
##########
versioned_docs/version-v0.15/UserManuals/ConfigUI/webhook.md:
##########
@@ -14,11 +14,17 @@ Go to the 'Data Connections' page. Create a webhook.
We recommend that you give your webhook connection a unique name so that you can identify and manage where you have used it later.
-### Step 2 - Use Webhooks
+### Step 2 - Create webhooks connection
Click on Generate POST URL, and 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.
Review Comment:
Click on `Generate POST URL`, and you will find three webhook URLs.
##########
docs/DORA.md:
##########
@@ -64,123 +66,132 @@ Calculating DORA metrics requires three key entities: **changes**, **deployments
In the next section, we'll demonstrate how to configure DevLake to implement DORA metrics for the aforementioned example team.
### Collect GitHub & Jira data via `blueprint`
+
1. Visit the config-ui at `http://localhost:4000`
-2. Create a `blueprint`, let's name it "Blueprint for DORA", add a Jira and a GitHub connection. Click `Next Step`
-
+2. Create a project: `project1`. And then create a `blueprint`, let's name it "Blueprint for DORA", add a Jira and a GitHub connection. Click `Next Step`
Review Comment:
Create a project: `project1`. Go to `project1`and create a `blueprint`...
##########
versioned_docs/version-v0.15/UserManuals/DORA.md:
##########
@@ -64,113 +66,123 @@ Calculating DORA metrics requires three key entities: **changes**, **deployments
In the next section, we'll demonstrate how to configure DevLake to implement DORA metrics for the aforementioned example team.
### Collect GitHub & Jira data via `blueprint`
+
1. Visit the config-ui at `http://localhost:4000`
-2. Create a `blueprint`, let's name it "Blueprint for DORA", add a Jira and a GitHub connection. Click `Next Step`
-
+2. Create a project: `project1`. And then create a `blueprint`, let's name it "Blueprint for DORA", add a Jira and a GitHub connection. Click `Next Step`
Review Comment:
Text change:
Create a project: `project1`. Go to `project1` and create a `blueprint`...
--
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: commits-unsubscribe@devlake.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-devlake-website] likyh commented on a diff in pull request #454: docs: add webhook usage docs in a project
Posted by "likyh (via GitHub)" <gi...@apache.org>.
likyh commented on code in PR #454:
URL: https://github.com/apache/incubator-devlake-website/pull/454#discussion_r1124024535
##########
versioned_docs/version-v0.15/UserManuals/DORA.md:
##########
@@ -64,113 +66,123 @@ Calculating DORA metrics requires three key entities: **changes**, **deployments
In the next section, we'll demonstrate how to configure DevLake to implement DORA metrics for the aforementioned example team.
### Collect GitHub & Jira data via `blueprint`
+
1. Visit the config-ui at `http://localhost:4000`
-2. Create a `blueprint`, let's name it "Blueprint for DORA", add a Jira and a GitHub connection. Click `Next Step`
-
+2. Create a project: `project1`. And then create a `blueprint`, let's name it "Blueprint for DORA", add a Jira and a GitHub connection. Click `Next Step`
+ 
+ 
3. Select Jira boards and GitHub repos to collect, click `Next Step`
-
+ 
4. Click `Add Transformation` to configure for DORA metrics
-
+ 
5. To make it simple, fields with a  label are DORA-related configurations for every data source. Via these fields, you can define what are "incidents" and "deployments" for each data source. After all data connections have been configured, click `Next Step`
+
- This team uses Jira issue types `Crash` and `Incident` as "incident", so choose the two types in field "incident". Jira issues in these two types will be transformed to "incidents" in DevLake.
- This team uses the GitHub action jobs named `deploy` and `build-and-deploy` to deploy, so type in `(?i)deploy` to match these jobs. These jobs will be transformed to "deployments" in DevLake.
- 
-
+ 
+
Note: The following example shows where to find GitHub action jobs. It's easy to mix them up with GitHub workflows.
-
6. Choose sync frequency, click 'Save and Run Now' to start data collection. The time to completion varies by data source and depends on the volume of data.
-
+ 
For more details, please refer to our [blueprint manuals](https://devlake.apache.org/docs/UserManuals/ConfigUI/Tutorial).
### Collect CircleCI data via `webhook`
Using CircleCI as an example, we demonstrate how to actively push data to DevLake using the Webhook approach, in cases where DevLake doesn't have a plugin specific to that tool to pull data from your data source.
-7. Visit "Data Connections" page in config-ui and select "Issue/Deployment Incoming Webhook".
+7. Go to the 'Data Connections' page. Create a webhook.
+
+
-8. Click "Add Incoming Webhook", give it a name, and click "Generate POST URL". DevLake will generate URLs that you can send JSON payloads to push `deployments` and `incidents` to Devlake. Copy the `Deployment` curl command.
-
-
+We recommend that you give your webhook connection a unique name so that you can identify and manage where you have used it later.
+
+8. Create a Project first, choose Incoming Webhooks, then you can `Add a Webhook` or `Select Existing Webhooks`. And click "Generate POST URL". DevLake will generate URLs that you can send JSON payloads to push `deployments` and `incidents` to Devlake. Copy the `Deployment` curl command.
Review Comment:
`Add a Webhook` here so that step 7 is not required?
--
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: commits-unsubscribe@devlake.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-devlake-website] Startrekzky commented on a diff in pull request #454: docs: add webhook usage docs in a project
Posted by "Startrekzky (via GitHub)" <gi...@apache.org>.
Startrekzky commented on code in PR #454:
URL: https://github.com/apache/incubator-devlake-website/pull/454#discussion_r1124332134
##########
docs/DORA.md:
##########
@@ -64,123 +66,132 @@ Calculating DORA metrics requires three key entities: **changes**, **deployments
In the next section, we'll demonstrate how to configure DevLake to implement DORA metrics for the aforementioned example team.
### Collect GitHub & Jira data via `blueprint`
+
1. Visit the config-ui at `http://localhost:4000`
-2. Create a `blueprint`, let's name it "Blueprint for DORA", add a Jira and a GitHub connection. Click `Next Step`
-
+2. Create a project: `project1`. And then create a `blueprint`, let's name it "Blueprint for DORA", add a Jira and a GitHub connection. Click `Next Step`
Review Comment:
Create a project: `project1`. Go to `project1` and create a `blueprint`...
--
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: commits-unsubscribe@devlake.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-devlake-website] abeizn commented on a diff in pull request #454: docs: add webhook usage docs in a project
Posted by "abeizn (via GitHub)" <gi...@apache.org>.
abeizn commented on code in PR #454:
URL: https://github.com/apache/incubator-devlake-website/pull/454#discussion_r1124030485
##########
versioned_docs/version-v0.15/UserManuals/DORA.md:
##########
@@ -64,113 +66,123 @@ Calculating DORA metrics requires three key entities: **changes**, **deployments
In the next section, we'll demonstrate how to configure DevLake to implement DORA metrics for the aforementioned example team.
### Collect GitHub & Jira data via `blueprint`
+
1. Visit the config-ui at `http://localhost:4000`
-2. Create a `blueprint`, let's name it "Blueprint for DORA", add a Jira and a GitHub connection. Click `Next Step`
-
+2. Create a project: `project1`. And then create a `blueprint`, let's name it "Blueprint for DORA", add a Jira and a GitHub connection. Click `Next Step`
+ 
+ 
3. Select Jira boards and GitHub repos to collect, click `Next Step`
-
+ 
4. Click `Add Transformation` to configure for DORA metrics
-
+ 
5. To make it simple, fields with a  label are DORA-related configurations for every data source. Via these fields, you can define what are "incidents" and "deployments" for each data source. After all data connections have been configured, click `Next Step`
+
- This team uses Jira issue types `Crash` and `Incident` as "incident", so choose the two types in field "incident". Jira issues in these two types will be transformed to "incidents" in DevLake.
- This team uses the GitHub action jobs named `deploy` and `build-and-deploy` to deploy, so type in `(?i)deploy` to match these jobs. These jobs will be transformed to "deployments" in DevLake.
- 
-
+ 
+
Note: The following example shows where to find GitHub action jobs. It's easy to mix them up with GitHub workflows.
-
6. Choose sync frequency, click 'Save and Run Now' to start data collection. The time to completion varies by data source and depends on the volume of data.
-
+ 
For more details, please refer to our [blueprint manuals](https://devlake.apache.org/docs/UserManuals/ConfigUI/Tutorial).
### Collect CircleCI data via `webhook`
Using CircleCI as an example, we demonstrate how to actively push data to DevLake using the Webhook approach, in cases where DevLake doesn't have a plugin specific to that tool to pull data from your data source.
-7. Visit "Data Connections" page in config-ui and select "Issue/Deployment Incoming Webhook".
+7. Go to the 'Data Connections' page. Create a webhook.
+
+
-8. Click "Add Incoming Webhook", give it a name, and click "Generate POST URL". DevLake will generate URLs that you can send JSON payloads to push `deployments` and `incidents` to Devlake. Copy the `Deployment` curl command.
-
-
+We recommend that you give your webhook connection a unique name so that you can identify and manage where you have used it later.
+
+8. Create a Project first, choose Incoming Webhooks, then you can `Add a Webhook` or `Select Existing Webhooks`. And click "Generate POST URL". DevLake will generate URLs that you can send JSON payloads to push `deployments` and `incidents` to Devlake. Copy the `Deployment` curl command.
Review Comment:
yes, I think the user can add a webhook in project directly
--
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: commits-unsubscribe@devlake.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-devlake-website] abeizn merged pull request #454: docs: add webhook usage docs in a project
Posted by "abeizn (via GitHub)" <gi...@apache.org>.
abeizn merged PR #454:
URL: https://github.com/apache/incubator-devlake-website/pull/454
--
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: commits-unsubscribe@devlake.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org