This is an automated email from the ASF dual-hosted git repository.
abeizn 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 983c87e3be5 docs: polish the issues.type description (#779)
983c87e3be5 is described below
commit 983c87e3be567015f5e531f4b9de71c82ee75890
Author: Louis.z <[email protected]>
AuthorDate: Thu Aug 22 13:29:34 2024 +0800
docs: polish the issues.type description (#779)
Co-authored-by: Startrekzky <[email protected]>
---
docs/DataModels/DevLakeDomainLayerSchema.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/docs/DataModels/DevLakeDomainLayerSchema.md
b/docs/DataModels/DevLakeDomainLayerSchema.md
index cc87ba23220..93473bfee22 100644
--- a/docs/DataModels/DevLakeDomainLayerSchema.md
+++ b/docs/DataModels/DevLakeDomainLayerSchema.md
@@ -74,14 +74,14 @@ An `issue` is the abstraction of
GitHub/GitLab/BitBucket/Jira/TAPD/Zentao... iss
| **field** | **type**
| **length** | **description**
[...]
|:----------------------------|:----------------------------------------------|:-----------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| `id` | varchar
| 255 | An issue's `id` is composed of < plugin >:< Entity >:< PK0
>[:PK1]..." <ul><li>For Github issues, a Github issue's id is like
"github:GithubIssues:< GithubIssueId >". E.g.
'github:GithubIssues:1049355647'</li> <li>For Jira issues, a Github repo's id
is like "jira:JiraIssues:< JiraSourceId >:< JiraIssueId >". E.g.
'jira:JiraIssues:1:10063'. < JiraSourceId > is used to identify which jira
source th [...]
+| `id` | varchar
| 255 | An issue's `id` is composed of < plugin >:< Entity >:< PK0
>[:PK1]..." <ul><li>For Github issues, a Github issue's id is like
"github:GithubIssues:< GithubIssueId >". E.g.
'github:GithubIssues:1049355647'</li> <li>For Jira issues, a Github repo's id
is like "jira:JiraIssues:< JiraSourceId >:< JiraIssueId >". E.g.
'jira:JiraIssues:1:10063'. < JiraSourceId > is used to identify which Jira
source th [...]
| `issue_key` | varchar
| 255 | The key of this issue. For example, the key of this Github
[issue](https://github.com/apache/incubator-devlake/issues/1145) is 1145.
[...]
| `url` | varchar
| 255 | The url of the issue. It's a web address in most cases.
[...]
| `title` | varchar
| 255 | The title of an issue
[...]
| `description` | longtext
| | The detailed description/summary of an issue
[...]
-| `type` | varchar
| 100 | The standard type of this issue. There are 3 standard types:
<ul><li>REQUIREMENT: this issue is a feature</li><li>BUG: this issue is a bug
found during test</li><li>INCIDENT: this issue is a bug found after
release</li></ul>The 3 standard types are transformed from the original types
of an issue. The transformation rule is set in the '.env' file or 'config-ui'
before data collection. For issues w [...]
+| `type` | varchar
| 100 | The standard type of this issue. There are 3 standard types:
<ul><li>REQUIREMENT: this issue is a feature</li><li>BUG: this issue is a bug
found during test</li><li>INCIDENT: this issue is a bug found after
release</li></ul>The 3 standard types are transformed from the original type of
an issue. The transformation rule is set in the Scope Config on the Connections
page of Jira, GitHub and etc. <b [...]
| `original_type` | varchar
| 100 | The original type of an issue.
[...]
-| `status` | varchar
| 100 | The standard statuses of this issue. There are 3 standard
statuses: <ul><li> TODO: this issue is in backlog or to-do
list</li><li>IN_PROGRESS: this issue is in progress</li><li>DONE: this issue is
resolved or closed</li></ul>The 3 standard statuses are transformed from the
original statuses of an issue. The transformation rule: <ul><li>For Jira issue
status: transformed from the Jira issue's `sta [...]
+| `status` | varchar
| 100 | The standard statuses of this issue. There are 3 standard
statuses: <ul><li> TODO: this issue is in backlog or to-do
list</li><li>IN_PROGRESS: this issue is in progress</li><li>DONE: this issue is
resolved or closed</li></ul>The 3 standard statuses are transformed from the
original statuses of an issue. The transformation rule: <ul><li>For Jira issue
status: transformed from the Jira issue's `sta [...]
| `original_status` | varchar
| 100 | The original status of an issue.
[...]
| `story_point` | double
| | The story point of this issue. Only certain types(e.g. story) of
Jira or TAPD issues has story points
[...]
| `priority` | varchar
| 255 | The priority of the issue
[...]
