You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by kl...@apache.org on 2022/10/27 07:34:50 UTC

[incubator-devlake-website] branch kw-devlake-3459-migration created (now ebe805daa)

This is an automated email from the ASF dual-hosted git repository.

klesh pushed a change to branch kw-devlake-3459-migration
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git


      at ebe805daa feat: add `Project` to Glossary

This branch includes the following new commits:

     new ebe805daa feat: add `Project` to Glossary

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.



[incubator-devlake-website] 01/01: feat: add `Project` to Glossary

Posted by kl...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

klesh pushed a commit to branch kw-devlake-3459-migration
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git

commit ebe805daa915fcd7b9cbb659852ecea85486fa1e
Author: Klesh Wong <zh...@merico.dev>
AuthorDate: Thu Oct 27 15:34:19 2022 +0800

    feat: add `Project` to Glossary
---
 docs/Glossary.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/docs/Glossary.md b/docs/Glossary.md
index c3bad3dcf..defcdbd44 100644
--- a/docs/Glossary.md
+++ b/docs/Glossary.md
@@ -13,6 +13,16 @@ description: >
 
 The following terms are arranged in the order of their appearance in the actual user workflow.
 
+### Projects
+**A project is a set of related [Data Scopes](#data-scope), the Data Scopes may contains different [Data Entities](#data-entities) from arbitrary [Data Sources](#data-sources) for Metric Computation**
+
+Project was introduced in v0.15 to solve some complex metric computation problems. For example, There was a **Change Failure Rate** in [DORA Metric](../UserManuals/DORA) which requires connecting Incident(issue.type = 'INCIDENT') to its related Deployment(cicd_task.type = 'DEPLOYMENT') to determine whether a Deployment failed or not. Unfortunately, most data sources do not offer this relationship, the only reasonable approach so far is to connect Incident to its Closest Deployment, witho [...]
+
+A project consists of the following elements:
+A set of Metrics(currently, only DORA)
+A [Blueprint](#blueprints) for active data collection
+A set of Incoming Webhooks for passive data collection
+
 ### Blueprints
 **A blueprint is the plan that covers all the work to get your raw data ready for query and metric computation in the dashboards.** Creating a blueprint consists of four steps:
 1. **Adding [Data Connections](Glossary.md#data-connections)**: For each [data source](Glossary.md#data-sources), one or more data connections can be added to a single blueprint, depending on the data you want to sync to DevLake.