This is an automated email from the ASF dual-hosted git repository.
yumeng 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 4daedddb9a docs: add scope config to KeyConcept (#560)
4daedddb9a is described below
commit 4daedddb9a3ff55facb2ab18a1af64d585df41e2
Author: Klesh Wong <[email protected]>
AuthorDate: Thu Jun 15 16:22:59 2023 +0800
docs: add scope config to KeyConcept (#560)
* docs: add scope config to KeyConcept
* fix: Update KeyConcepts.md
---------
Co-authored-by: Yumeng Wang <[email protected]>
---
docs/DeveloperManuals/Project.md | 2 +-
docs/Overview/KeyConcepts.md | 12 ++++++++++--
2 files changed, 11 insertions(+), 3 deletions(-)
diff --git a/docs/DeveloperManuals/Project.md b/docs/DeveloperManuals/Project.md
index bd1cc85c0f..158d15eb8c 100644
--- a/docs/DeveloperManuals/Project.md
+++ b/docs/DeveloperManuals/Project.md
@@ -203,7 +203,7 @@ And the `plugins/gitlab/api/blueprint_v200.go` contains
implementation details.
The following files contain the models that the relevant implementations
depend on for reference:
- `plugins/gitlab/models/project.go`
-- `plugins/gitlab/models/transformation_rule.go`
+- `plugins/gitlab/models/scope_config.go`
## Metric Plugins
diff --git a/docs/Overview/KeyConcepts.md b/docs/Overview/KeyConcepts.md
index dcd4739760..49ca40a34a 100644
--- a/docs/Overview/KeyConcepts.md
+++ b/docs/Overview/KeyConcepts.md
@@ -48,6 +48,14 @@ The recommended way to set up a new data connection is via
the Data Connections
### Data Scope(s)
**A data scope is the top-level "container" in a data source**. For example, a
data scope for Jira is a Jira board, for TAPD is a TAPD workspace, for
GitHub/GitLab/BitBucket is a repo, for Jenkins is a Jenkins job, etc. You can
add multiple data scopes to a data connection to determine which data to
collect. Data scopes vary for different data sources.
+
+### Scope Configs
+**A scope config is a shared configuration among multiple data scopes under
the same connection.** The fields of the Scope Config vary depending on the
data sources.
+
+Most often, when we collect multiple data scopes from a data source, such as
gathering multiple repositories from GitHub, some of them (repositories) might
share the same configuration because they are maintained by the same group of
people or follow company policy. In cases like this, storing the configuration
in a separate entity is helpful to avoid repeatedly entering the same set of
settings. However, it is important to note that changing the Scope Config would
affect every single da [...]
+
+Scope Config consists of [Data Entities](#data-entities) and
[Transformations](#transformations)
+
### Data Entities
**Data entities refer to the data fields from one of the five data domains:
Issue Tracking, Source Code Management, Code Review, CI/CD and Cross-Domain.**
@@ -55,8 +63,8 @@ For instance, if you wish to pull Source Code Management data
from GitHub and Is
To learn more details, please refer to [Domain Layer
Schema](/DataModels/DevLakeDomainLayerSchema.md).
-### Transformation Rules
-**Transformation rules are a collection of methods that allow you to customize
how DevLake normalizes raw data for query and metric computation.** Each set of
data scope is strictly accompanied with one set of transformation rules.
However, for your convenience, transformation rules can also be duplicated
across different sets of data scope.
+### Transformations
+**Transformations are a collection of methods that allow you to customize how
DevLake normalizes raw data for query and metric computation.** Each set of
data scope is strictly accompanied with one set of transformations. However,
for your convenience, transformations can also be duplicated across different
sets of data scope.
DevLake uses these normalized values in the transformation to design more
advanced dashboards, such as the Weekly Bug Retro dashboard. Although
configuring transformation rules is not mandatory, if you leave the rules blank
or have not configured correctly, only the basic dashboards (e.g. GitHub Basic
Metrics) will be displayed as expected, while the advanced dashboards will not.
