This is an automated email from the ASF dual-hosted git repository.
warren 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 744221f94 docs(plugins): update zentao and tapd
744221f94 is described below
commit 744221f94a6a85f75cd37feb0c9c5ba4ede1f70d
Author: Yingchu Chen <[email protected]>
AuthorDate: Mon Dec 26 21:46:12 2022 +0800
docs(plugins): update zentao and tapd
---
docs/Plugins/github.md | 2 +
docs/Plugins/gitlab.md | 4 +-
docs/Plugins/jira.md | 26 +++---
docs/Plugins/tapd.md | 64 +++----------
docs/Plugins/zentao.md | 22 +++++
docs/UserManuals/ConfigUI/AdvancedMode.md | 99 ++++++++++++++++++++-
docs/UserManuals/ConfigUI/Zentao.md | 30 +++++++
docs/UserManuals/ConfigUI/zentao-execution-id.png | Bin 0 -> 58198 bytes
docs/UserManuals/ConfigUI/zentao-product-id.png | Bin 0 -> 62149 bytes
docs/UserManuals/ConfigUI/zentao-product.png | Bin 0 -> 75333 bytes
docs/UserManuals/ConfigUI/zentao-project-id.png | Bin 0 -> 58058 bytes
.../img/ConfigUI/zentao-add-data-connections.png | Bin 0 -> 53048 bytes
12 files changed, 177 insertions(+), 70 deletions(-)
diff --git a/docs/Plugins/github.md b/docs/Plugins/github.md
index c9b17d5c4..5d3dbd69a 100644
--- a/docs/Plugins/github.md
+++ b/docs/Plugins/github.md
@@ -57,6 +57,8 @@ Metrics that can be calculated based on the data collected
from GitHub:
## Configuration
- Configuring GitHub via [Config UI](/UserManuals/ConfigUI/GitHub.md)
+- Configuring GitHub via Config UI's [advanced
mode](/UserManuals/ConfigUI/AdvancedMode.md#2-github).
+
## API Sample Request
diff --git a/docs/Plugins/gitlab.md b/docs/Plugins/gitlab.md
index 07a498781..581f4cd29 100644
--- a/docs/Plugins/gitlab.md
+++ b/docs/Plugins/gitlab.md
@@ -49,7 +49,9 @@ Metrics that can be calculated based on the data collected
from GitLab:
## Configuration
-Configuring GitLab via [config-ui](/UserManuals/ConfigUI/GitLab.md).
+- Configuring GitLab via [config-ui](/UserManuals/ConfigUI/GitLab.md).
+- Configuring GitLab via Config UI's [advanced
mode](/UserManuals/ConfigUI/AdvancedMode.md#1-gitlab).
+
## API Sample Request
diff --git a/docs/Plugins/jira.md b/docs/Plugins/jira.md
index 5b512b77b..b6497cd16 100644
--- a/docs/Plugins/jira.md
+++ b/docs/Plugins/jira.md
@@ -11,20 +11,18 @@ This plugin collects Jira data through Jira Cloud REST API.
It then computes and
<img width="2035" alt="jira metric display"
src="https://user-images.githubusercontent.com/2908155/132926143-7a31d37f-22e1-487d-92a3-cf62e402e5a8.png";
/>
-## Project Metrics This Covers
-
-| Metric Name | Description
|
-|:------------------------------------|:--------------------------------------------------------------------------------------------------|
-| Requirement Count | Number of issues with type
"Requirement" |
-| Requirement Lead Time | Lead time of issues with type
"Requirement" |
-| Requirement Delivery Rate | Ratio of delivered requirements to all
requirements |
-| Requirement Granularity | Number of story points associated with
an issue |
-| Bug Count | Number of issues with type
"Bug"<br/><i>bugs are found during testing</i> |
-| Bug Age | Lead time of issues with type
"Bug"<br/><i>both new and deleted lines count</i> |
-| Bugs Count per 1k Lines of Code | Amount of bugs per 1000 lines of code
|
-| Incident Count | Number of issues with type
"Incident"<br/><i>incidents are found when running in production</i> |
-| Incident Age | Lead time of issues with type
"Incident" |
-| Incident Count per 1k Lines of Code | Amount of incidents per 1000 lines of
code |
+## Metrics
+
+Metrics that can be calculated based on the data collected from Jira:
+
+- [Requirement Count](/Metrics/RequirementCount.md)
+- [Requirement Lead Time](/Metrics/RequirementLeadTime.md)
+- [Requirement Delivery Rate](/Metrics/RequirementDeliveryRate.md)
+- [Requirement Granularity](/Metrics/RequirementGranularity.md)
+- [Bug Age](/Metrics/BugAge.md)
+- [Bug Count per 1k Lines of Code](/Metrics/BugCountPer1kLinesOfCode.md)
+- [Incident Age](/Metrics/IncidentAge.md)
+- [Incident Count per 1k Lines of
Code](/Metrics/IncidentCountPer1kLinesOfCode.md)
## Configuration
Configuring Jira via [config-ui](/UserManuals/ConfigUI/Jira.md).
diff --git a/docs/Plugins/tapd.md b/docs/Plugins/tapd.md
index 47eaf991a..332b91115 100644
--- a/docs/Plugins/tapd.md
+++ b/docs/Plugins/tapd.md
@@ -5,61 +5,19 @@ description: >
---
## Summary
+This plugin collects TAPD data through its REST APIs. TAPD is an
issue-tracking tool similar to Jira.
-This plugin collects Tapd data through Tapd REST API.
+## Metrics
-## Configuration
-Configuring Tapd via [config-ui](/UserManuals/ConfigUI/Tapd.md).
-
-## Collect Data From Tapd
-
-To collect data, select `Advanced Mode` on the `Create Blueprint` page and
paste a JSON config like the following:
+Metrics that can be calculated based on the data collected from Tapd:
-> <font color="#ED6A45">Warning: Data collection only supports single-task
execution, and the results of concurrent multi-task execution may not meet
expectations.</font>
+- [Requirement Count](/Metrics/RequirementCount.md)
+- [Requirement Lead Time](/Metrics/RequirementLeadTime.md)
+- [Requirement Delivery Rate](/Metrics/RequirementDeliveryRate.md)
+- [Bug Age](/Metrics/BugAge.md)
+- [Incident Age](/Metrics/IncidentAge.md)
-```
-[
- [
- {
- "plugin": "tapd",
- "options": {
- "workspaceId": 34***66,
- "connectionId": 1
- }
- }
- ],
- [
- {
- "plugin": "tapd",
- "options": {
- "workspaceId": 6***14,
- "connectionId": 1
- }
- }
- ]
-]
-```
-
-- `connectionId`: The `ID` field from **TAPD Integration** page.
-- `workspaceId`: TAPD workspace id, you can get it from two ways:
- - url: 
- - db: you can check workspace info from db._tool_tapd_workspaces and get all
workspaceId you want to collect after execution of the following json in
`advanced mode`
- ```json
- [
- [
- {
- "plugin": "tapd",
- "options": {
- "companyId": 55850509,
- "workspaceId": 1,
- "connectionId": 1
- },
- "subtasks": [
- "collectCompanies",
- "extractCompanies"
- ]
- }
- ]
- ]
- ```
+## Configuration
+- Configuring Tapd via [config-ui](/UserManuals/ConfigUI/Tapd.md).
+- Configuring Tapd via Config UI's [advanced
mode](/UserManuals/ConfigUI/AdvancedMode.md#4-tapd).
diff --git a/docs/Plugins/zentao.md b/docs/Plugins/zentao.md
new file mode 100644
index 000000000..5e1619ad9
--- /dev/null
+++ b/docs/Plugins/zentao.md
@@ -0,0 +1,22 @@
+---
+title: "Zentao"
+description: >
+ Zentao Plugin
+---
+
+## Summary
+This plugin collects Zentao data through its REST APIs.
[Zentao](https://github.com/easysoft/zentaopms) is an issue-tracking tool
similar to Jira.
+
+## Metrics
+
+Metrics that can be calculated based on the data collected from Zentao:
+
+- [Requirement Count](/Metrics/RequirementCount.md)
+- [Requirement Lead Time](/Metrics/RequirementLeadTime.md)
+- [Requirement Delivery Rate](/Metrics/RequirementDeliveryRate.md)
+- [Bug Age](/Metrics/BugAge.md)
+- [Incident Age](/Metrics/IncidentAge.md)
+
+## Configuration
+- Configuring Zentao via [config-ui](/UserManuals/ConfigUI/Zentao.md).
+- Configuring Zentao via Config UI's [advanced
mode](/UserManuals/ConfigUI/AdvancedMode.md#3-zentao).
diff --git a/docs/UserManuals/ConfigUI/AdvancedMode.md
b/docs/UserManuals/ConfigUI/AdvancedMode.md
index ef3354729..68a7568c8 100644
--- a/docs/UserManuals/ConfigUI/AdvancedMode.md
+++ b/docs/UserManuals/ConfigUI/AdvancedMode.md
@@ -33,7 +33,8 @@ Advanced mode gives utmost flexibility to users by exposing
the JSON API.
## Examples
-1. Collect multiple GitLab repos sequentially.
+### 1. Gitlab
+Collect multiple GitLab repos sequentially.
> When there're multiple collection tasks against a single data source, we
> recommend running these tasks sequentially since the collection speed is
> mostly limited by the API rate limit of the data source.
> Running multiple tasks against the same data source is unlikely to speed up
> the process and may overwhelm the data source.
@@ -61,7 +62,8 @@ Below is an example for collecting 2 GitLab repos
sequentially. It has 2 stages,
]
```
-2. Collect a GitHub repo and a Jira board in parallel
+### 2. Github
+Collect a GitHub repo and a Jira board in parallel
Below is an example for collecting a GitHub repo and a Jira board in parallel.
It has a single stage with a GitHub task and a Jira task. Since users can
configure multiple Jira connection, it's required to pass in a `connectionId`
for Jira task to specify which connection to use.
@@ -86,6 +88,99 @@ Below is an example for collecting a GitHub repo and a Jira
board in parallel. I
]
```
+### 3. Zentao
+Below is an example for collecting a Zentao workspace. Since users can
configure multiple Zentao connection, it's required to pass in a `connectionId`
for Tapd task to specify which connection to use.
+
+```
+[
+ [
+ {
+ plugin: 'zentao',
+ options: {
+ connectionId: 1,
+ productId: 1,
+ projectId: 1,
+ executionId: 1
+ }
+ }
+ ]
+]
+```
+
+- `connectionId`: The `ID` field from **ZENTAO Integration** page.
+- `productId`: optional, ZENTAO product id, see "Find Product Id" for details.
+- `projectId`: optional, ZENTAO product id, see "Find Project Id" for details.
+- `executionId`: optional, ZENTAO product id, see "Find Execution Id" for
details.
+
+You must choose at least one of `productId`, `projectId` and `executionId`.
+
+#### Find Product Id
+1. Navigate to the Zentao Product in the browser
+ 
+2. Click the red square annotated in the pic above
+ 
+3. Then the number in the red circle above is `ProductId`
+
+#### Find Project Id
+1. Navigate to the Zentao Project in the browser
+ 
+2. Then the number in the red square above is `ProjectId`
+
+#### Find Execution Id
+1. Navigate to the Zentao Execution in the browser
+ 
+2. Then the number in the red square above is `ExecutionId`
+
+### 4. Tapd
+Below is an example for collecting a Tapd workspace. Since users can configure
multiple Tapd connection, it's required to pass in a `connectionId` for Tapd
task to specify which connection to use.
+```
+[
+ [
+ {
+ "plugin": "tapd",
+ "options": {
+ "workspaceId": 34***66,
+ "connectionId": 1
+ }
+ }
+ ],
+ [
+ {
+ "plugin": "tapd",
+ "options": {
+ "workspaceId": 6***14,
+ "connectionId": 1
+ }
+ }
+ ]
+]
+```
+
+- `connectionId`: The `ID` field from **TAPD Integration** page.
+- `workspaceId`: TAPD workspace id, you can get it from two ways:
+ - url: 
+ - db: you can check workspace info from db._tool_tapd_workspaces and get all
workspaceId you want to collect after execution of the following json in
`advanced mode`
+ ```json
+ [
+ [
+ {
+ "plugin": "tapd",
+ "options": {
+ "companyId": 55850509,
+ "workspaceId": 1,
+ "connectionId": 1
+ },
+ "subtasks": [
+ "collectCompanies",
+ "extractCompanies"
+ ]
+ }
+ ]
+ ]
+ ```
+
+
+
## Editing a Blueprint (Advanced Mode)
This section is for editing a Blueprint in the Advanced Mode. To edit in the
Normal mode, please refer to [this
guide](Tutorial.md#editing-a-blueprint-normal-mode).
diff --git a/docs/UserManuals/ConfigUI/Zentao.md
b/docs/UserManuals/ConfigUI/Zentao.md
new file mode 100644
index 000000000..966404f97
--- /dev/null
+++ b/docs/UserManuals/ConfigUI/Zentao.md
@@ -0,0 +1,30 @@
+---
+title: "Configuring Zentao(WIP)"
+sidebar_position: 6
+description: Config UI instruction for Zentao
+---
+
+Visit config-ui: `http://localhost:4000`.
+### Step 1 - Add Data Connections
+
+
+#### Connection Name
+Name your connection.
+
+#### Endpoint URL
+This should be a valid REST API endpoint
+ - `https://YOUR_DOMAIN:YOUR_PORT/`
+The endpoint url should end with `/`.
+
+#### Username / Password
+Input the username and password of your Zentao account.
+
+#### Proxy URL (Optional)
+If you are behind a corporate firewall or VPN you may need to utilize a proxy
server. Enter a valid proxy server address on your network, e.g.
`http://your-proxy-server.com:1080`
+
+#### Test and Save Connection
+Click `Test Connection`, if the connection is successful, click `Save
Connection` to add the connection.
+
+## Troubleshooting
+
+If you run into any problem, please check the
[Troubleshooting](/Troubleshooting/Configuration.md) or [create an
issue](https://github.com/apache/incubator-devlake/issues)
diff --git a/docs/UserManuals/ConfigUI/zentao-execution-id.png
b/docs/UserManuals/ConfigUI/zentao-execution-id.png
new file mode 100644
index 000000000..ff50b91d3
Binary files /dev/null and b/docs/UserManuals/ConfigUI/zentao-execution-id.png
differ
diff --git a/docs/UserManuals/ConfigUI/zentao-product-id.png
b/docs/UserManuals/ConfigUI/zentao-product-id.png
new file mode 100644
index 000000000..caf110c48
Binary files /dev/null and b/docs/UserManuals/ConfigUI/zentao-product-id.png
differ
diff --git a/docs/UserManuals/ConfigUI/zentao-product.png
b/docs/UserManuals/ConfigUI/zentao-product.png
new file mode 100644
index 000000000..25e9f50f0
Binary files /dev/null and b/docs/UserManuals/ConfigUI/zentao-product.png differ
diff --git a/docs/UserManuals/ConfigUI/zentao-project-id.png
b/docs/UserManuals/ConfigUI/zentao-project-id.png
new file mode 100644
index 000000000..6775fbb09
Binary files /dev/null and b/docs/UserManuals/ConfigUI/zentao-project-id.png
differ
diff --git a/static/img/ConfigUI/zentao-add-data-connections.png
b/static/img/ConfigUI/zentao-add-data-connections.png
new file mode 100644
index 000000000..adcd82bff
Binary files /dev/null and
b/static/img/ConfigUI/zentao-add-data-connections.png differ
![https://user-images.githubusercontent.com/2908155/132926143-7a31d37f-22e1-487d-92a3-cf62e402e5a8.png"](https://user-images.githubusercontent.com/2908155/132926143-7a31d37f-22e1-487d-92a3-cf62e402e5a8.png"){kind=link}