[GitHub] [incubator-devlake-website] Startrekzky commented on a diff in pull request #298: docs: add `Project` to Glossary

[GitBox <gi...@apache.org>]

Startrekzky commented on code in PR #298:
URL: https://github.com/apache/incubator-devlake-website/pull/298#discussion_r1008067796


##########
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, without Project, 

Review Comment:
   1. "Project was introduced in v0.15" to "Project will be introduced in v0.15"
   2. typo: "For example, There was" to "For example, there is"
   3. "the only reasonable approach so far is to connect Incident to its Closest Deployment, without Project," to "the only reasonable approach so far is to map an Incident to its closest Deployment."
   4. why is there a ", without Project," end with a `,`? 



##########
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**

Review Comment:
   1. Text change: "may contains" to "may contain"
   2. Can you add an example to explain what is a concrete data scope/entities?  Something like "For example, a project collects the data from GitHub repo A&B and Jira board C. GitHub Repo A, GitHub repo B and Jira board C are three separate Data Scopes......"



##########
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, without Project, 
+
+A project consists of the following elements:
+A set of Metrics(currently, only DORA)
+A [Blueprint](#blueprints) for active data collection

Review Comment:
   1. A [`Blueprint`](#blueprints) to pull data from [supported data sources](https://devlake.apache.org/docs/next/SupportedDataSources). You can change it to the relative path.
   2. A set of `Incoming Webhooks` to receive pushed from non-supported data sources



-- 
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