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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
