Startrekzky commented on code in PR #308:
URL:
https://github.com/apache/incubator-devlake-website/pull/308#discussion_r1010279548
##########
docs/DeveloperManuals/Project.md:
##########
@@ -0,0 +1,184 @@
+---
+title: "Project"
+sidebar_position: 5
+description: >
+ `Project` is an object that can be used for DORA to associate
`changes(commits)`, with `deployments` and `issues`.
+---
+
+## Summary
+`Project` is an object that can be used for DORA to associate
`changes(commits)`, with `deployments` and `issues`.
+
+It contains the following two models:
+ - `projects` describes a project object, including its name, creation and
update time and other basic information
+ - `project_metrics` describes the mapping relationship enabled by a plugin,
including the name of the project and plugin on both sides of the mapping, and
basic information about plugin options.
+
+
+
+## project
+
+| **field** | **type** | **length** | **description** |
**key** |
+| ------------- | -------- | ---------- | ----------------------------- |
------- |
+| `name` | varchar | 255 | name for project | PK
|
+| `describe` | longtext | | describe for project |
|
+| `created_at` | datetime | 3 | created time of project |
|
+| `updated_at` | datetime | 3 | last updated time of project |
|
+
+
+| **name** | **describe** | **created_at** |
**updated_at** |
+| --------- | ------------------------------------ | ----------------------- |
------------------------|
+| project_1 | this is one of test project | 2022-11-01 01:22:13.000 |
2022-11-01 02:24:15.000 |
Review Comment:
text change:
'this is one of test project' to 'this is one of the test projects'
##########
docs/DeveloperManuals/Project.md:
##########
@@ -0,0 +1,184 @@
+---
+title: "Project"
+sidebar_position: 5
+description: >
+ `Project` is an object that can be used for DORA to associate
`changes(commits)`, with `deployments` and `issues`.
+---
+
+## Summary
+`Project` is an object that can be used for DORA to associate
`changes(commits)`, with `deployments` and `issues`.
+
+It contains the following two models:
+ - `projects` describes a project object, including its name, creation and
update time and other basic information
+ - `project_metrics` describes the mapping relationship enabled by a plugin,
including the name of the project and plugin on both sides of the mapping, and
basic information about plugin options.
+
+
+
+## project
+
+| **field** | **type** | **length** | **description** |
**key** |
+| ------------- | -------- | ---------- | ----------------------------- |
------- |
+| `name` | varchar | 255 | name for project | PK
|
+| `describe` | longtext | | describe for project |
|
Review Comment:
Shall we use `description` and `description of the project`?
##########
docs/DeveloperManuals/Project.md:
##########
@@ -0,0 +1,184 @@
+---
+title: "Project"
+sidebar_position: 5
+description: >
+ `Project` is an object that can be used for DORA to associate
`changes(commits)`, with `deployments` and `issues`.
+---
+
+## Summary
+`Project` is an object that can be used for DORA to associate
`changes(commits)`, with `deployments` and `issues`.
+
+It contains the following two models:
+ - `projects` describes a project object, including its name, creation and
update time and other basic information
+ - `project_metrics` describes the mapping relationship enabled by a plugin,
including the name of the project and plugin on both sides of the mapping, and
basic information about plugin options.
+
+
+
+## project
+
+| **field** | **type** | **length** | **description** |
**key** |
+| ------------- | -------- | ---------- | ----------------------------- |
------- |
+| `name` | varchar | 255 | name for project | PK
|
+| `describe` | longtext | | describe for project |
|
+| `created_at` | datetime | 3 | created time of project |
|
+| `updated_at` | datetime | 3 | last updated time of project |
|
+
+
+| **name** | **describe** | **created_at** |
**updated_at** |
+| --------- | ------------------------------------ | ----------------------- |
------------------------|
+| project_1 | this is one of test project | 2022-11-01 01:22:13.000 |
2022-11-01 02:24:15.000 |
+| project_2 | this is another project test project | 2022-11-01 01:23:29.000 |
2022-11-01 02:27:24.000 |
+
+## project_metric
+
+| **field** | **type** | **length** | **description**
| **key** |
+| ------------- | -------- | ---------- |
---------------------------------------------------------- | ------- |
+| `project_name` | varchar | 255 | name for project
| PK |
+| `plugin_name` | varchar | 255 | name for plugin
| PK |
+| `plugin_option` | longtext | | check if metric plugins have been
enabled by the project | |
+
+
+| **project_name** | **plugin_name** | **plugin_option** |
+| ---------------- | --------------- | ---------------------- |
+| project_1 | gitlab | {'enable':true} |
+| project_2 | gitlab | {'enable':disable} |
Review Comment:
Can project_2 map to another plugin, like github?
--
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]
