You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by yu...@apache.org on 2023/05/09 07:48:11 UTC
[incubator-devlake-website] branch main updated: docs: update and fix typo in teambition docs (#519)
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 079be9f6c1 docs: update and fix typo in teambition docs (#519)
079be9f6c1 is described below
commit 079be9f6c1c5ba393f990bdb07ac68d07289b33c
Author: Xiaojian Zheng <11...@users.noreply.github.com>
AuthorDate: Tue May 9 15:48:06 2023 +0800
docs: update and fix typo in teambition docs (#519)
---
docs/Configuration/AdvancedMode.md | 2 +-
docs/Configuration/Teambition.md | 2 +-
docs/Overview/Roadmap.md | 2 +-
docs/Overview/SupportedDataSources.md | 33 +++++++++++++++++----------------
docs/Plugins/teambition.md | 4 ++--
5 files changed, 22 insertions(+), 21 deletions(-)
diff --git a/docs/Configuration/AdvancedMode.md b/docs/Configuration/AdvancedMode.md
index acd2672fdc..0d6535c850 100644
--- a/docs/Configuration/AdvancedMode.md
+++ b/docs/Configuration/AdvancedMode.md
@@ -372,7 +372,7 @@ Below is an example for collecting a Teambition project. Since users can configu
]
```
-- `connectionId`: The ID of your TAPD connection at page http://localhost:4000/connections/tapd.
+- `connectionId`: The ID of your Teambition connection at page http://localhost:4000/connections/teambition.
- `projectId`: Teambition project id, you can get it from url: 
## Editing a Blueprint (Advanced Mode)
diff --git a/docs/Configuration/Teambition.md b/docs/Configuration/Teambition.md
index a82c61bbf5..d428f953d6 100644
--- a/docs/Configuration/Teambition.md
+++ b/docs/Configuration/Teambition.md
@@ -49,7 +49,7 @@ Click `Test Connection`, if the connection is successful, click `Save Connection
Similar to other beta plugins, Teambition does not support `project`, which means, you can only collect Teambition data via blueprint's advanced mode.
-Please go to the `Blueprints` page and switch to advanced mode. See how to use advanced mode and JSON [examples](AdvancedMode.md#11-Teambition).
+Please go to the `Blueprints` page and switch to advanced mode. See how to use advanced mode and JSON [examples](AdvancedMode.md#11-teambition).
## Troubleshooting
diff --git a/docs/Overview/Roadmap.md b/docs/Overview/Roadmap.md
index 40585bdaf5..556b0e5ad2 100644
--- a/docs/Overview/Roadmap.md
+++ b/docs/Overview/Roadmap.md
@@ -22,7 +22,7 @@ Apache DevLake is currently under rapid development. You are more than welcome t
| Category | Features |
| -------- | -------- |
-| More data sources across different DevOps domains (Goal No.1 & 2). See [existing data sources](/docs/Overview/SupportedDataSources.md) | Issue Tracking: <ul><li>Jira (cloud) [#886 (Done)](https://github.com/apache/incubator-devlake/issues/886)</li><li>Jira (server/data center) [#1687 (Done)](https://github.com/apache/incubator-devlake/issues/1687)</li><li>GitHub Issues [#407 (Done)](https://github.com/apache/incubator-devlake/issues/407)</li><li>GitLab Issues [#715 (Done)](https://gith [...]
+| More data sources across different DevOps domains (Goal No.1 & 2). See [existing data sources](/docs/Overview/SupportedDataSources.md) | Issue Tracking: <ul><li>Jira (cloud) [#886 (Done)](https://github.com/apache/incubator-devlake/issues/886)</li><li>Jira (server/data center) [#1687 (Done)](https://github.com/apache/incubator-devlake/issues/1687)</li><li>GitHub Issues [#407 (Done)](https://github.com/apache/incubator-devlake/issues/407)</li><li>GitLab Issues [#715 (Done)](https://gith [...]
| Improved data collection, [data models](../DataModels/DevLakeDomainLayerSchema.md) and data extensibility (Goal No.2) | Data Collection: <br/> <ul><li>Complete the logging system</li><li>Implement a good error handling mechanism during data collection</li></ul> Data Models:<ul><li>Introduce DBT to allow users to create and modify the domain layer schema. [#1479 (Done)](https://github.com/apache/incubator-devlake/issues/1479)</li><li>Design the data models for 6 new domains, please refe [...]
| Better user experience (Goal No.3) | For new users: <ul><li> Iterate on a clearer step-by-step guide to improve the pre-configuration experience.</li><li>Provide a new Config UI to reduce frictions for data configuration [#1700 (Done)](https://github.com/apache/incubator-devlake/issues/1700)</li><li> Showcase dashboard live demos to let users explore and learn about the dashboards. [#1784 (Done)](https:/ [...]
diff --git a/docs/Overview/SupportedDataSources.md b/docs/Overview/SupportedDataSources.md
index 7f31b71ff8..db831962b9 100644
--- a/docs/Overview/SupportedDataSources.md
+++ b/docs/Overview/SupportedDataSources.md
@@ -9,22 +9,23 @@ sidebar_position: 5
Apache DevLake(incubating) supports the following data sources. The data from each data source is collected with one or more plugins. Detailed plugin docs can be found [here](/docs/Plugins).
-| Data Source | Domain(s) | Supported Versions | Config UI Availability | Triggered Plugins | Collection Mode |
-| ------------------- | ---------------------------------------------------------------------------- | ---------------------------------- | ----------------------- | ------------------------------ | --------------------------------------------------------------- |
-| GitHub | Source Code Management, Code Review, Issue Tracking, CI/CD (GitHub Actions) | Cloud | Available | `github`, `gitextractor` | Incremental Sync |
-| GitLab | Source Code Management, Code Review, Issue Tracking, CI/CD (GitLab CI) | Cloud, Community Edition 11+ | Available | `gitlab`, `gitextractor` | Full Refresh, Incremental Sync(for `issues`,`MRs`) |
-| Jira | Issue Tracking | Cloud, Server/Data Center 7.x, 8.x | Available | `jira` | Full Refresh, Incremental Sync(for `issues` and related) |
-| Jenkins | CI/CD | 2.263.x+ | Available | `jenkins` | Incremental Sync |
-| BitBucket (Beta) | Source Code Management, Code Review | Cloud | Advanced Mode Available | `bitbucket`, `gitextractor` | Full Refresh |
-| TAPD (Beta) | Issue Tracking | Cloud | Advanced Mode Available | `tapd` | Full Refresh, Incremental Sync(for `stories`, `bugs`, `tasks`) |
-| Zentao (Beta) | Issue Tracking | v17.x, v18.x | Advanced Mode Available | `zentao` | Full Refresh |
-| Gitee (WIP) | Source Code Management, Code Review, Issue Tracking | Cloud | Not Available | `gitee`, `gitextractor` | Full Refresh, Incremental Sync(for `issues`,`MRs`) |
-| PagerDuty (WIP) | Issue Tracking | Cloud | Not Available | `pagerduty` | Full Refresh |
-| Feishu (WIP) | Calendar | Cloud | Not Available | `feishu` | Full Refresh |
-| AE | Source Code Management | On-prem | Not Available | `ae` | Full Refresh |
-| Sonarqube | CODE QUALITY | SonarQube v8.x, v9.x | Available | `sonarqube` | Full Refresh |
-| Bamboo CI(WIP) | CI/CD | v6.8.1 | Not Available | `bamboo` | Full Refresh |
-| Azure Devops (Beta) | CI/CD, Source Code Management, Code Review | Cloud | Available | `azuredevops`, `gitextractor` | Full Refresh |
+| Data Source | Domain(s) | Supported Versions | Config UI Availability | Triggered Plugins | Collection Mode |
+|---------------------| ---------------------------------------------------------------------------- | ---------------------------------- | ----------------------- |-------------------------------|----------------------------------------------------------------|
+| GitHub | Source Code Management, Code Review, Issue Tracking, CI/CD (GitHub Actions) | Cloud | Available | `github`, `gitextractor` | Incremental Sync |
+| GitLab | Source Code Management, Code Review, Issue Tracking, CI/CD (GitLab CI) | Cloud, Community Edition 11+ | Available | `gitlab`, `gitextractor` | Full Refresh, Incremental Sync(for `issues`,`MRs`) |
+| Jira | Issue Tracking | Cloud, Server/Data Center 7.x, 8.x | Available | `jira` | Full Refresh, Incremental Sync(for `issues` and related) |
+| Jenkins | CI/CD | 2.263.x+ | Available | `jenkins` | Incremental Sync |
+| BitBucket (Beta) | Source Code Management, Code Review | Cloud | Advanced Mode Available | `bitbucket`, `gitextractor` | Full Refresh |
+| TAPD (Beta) | Issue Tracking | Cloud | Advanced Mode Available | `tapd` | Full Refresh, Incremental Sync(for `stories`, `bugs`, `tasks`) |
+| Teambition (Beta) | Issue Tracking | Cloud | Advanced Mode Available | `teambition` | Full Refresh |
+| Zentao (Beta) | Issue Tracking | v17.x, v18.x | Advanced Mode Available | `zentao` | Full Refresh |
+| Gitee (WIP) | Source Code Management, Code Review, Issue Tracking | Cloud | Not Available | `gitee`, `gitextractor` | Full Refresh, Incremental Sync(for `issues`,`MRs`) |
+| PagerDuty (WIP) | Issue Tracking | Cloud | Not Available | `pagerduty` | Full Refresh |
+| Feishu (WIP) | Calendar | Cloud | Not Available | `feishu` | Full Refresh |
+| AE | Source Code Management | On-prem | Not Available | `ae` | Full Refresh |
+| Sonarqube | CODE QUALITY | SonarQube v8.x, v9.x | Available | `sonarqube` | Full Refresh |
+| Bamboo CI(WIP) | CI/CD | v6.8.1 | Not Available | `bamboo` | Full Refresh |
+| Azure Devops (Beta) | CI/CD, Source Code Management, Code Review | Cloud | Available | `azuredevops`, `gitextractor` | Full Refresh |
## Data Collection Scope By Each Plugin
diff --git a/docs/Plugins/teambition.md b/docs/Plugins/teambition.md
index 6560964c31..9f3ac113cb 100644
--- a/docs/Plugins/teambition.md
+++ b/docs/Plugins/teambition.md
@@ -11,7 +11,7 @@ This plugin collects Teambition data through its REST APIs. Teambition is an iss
## Metrics
-Metrics that can be calculated based on the data collected from Tapd:
+Metrics that can be calculated based on the data collected from Teambition:
- [Requirement Count](/Metrics/RequirementCount.md)
- [Requirement Lead Time](/Metrics/RequirementLeadTime.md)
@@ -22,4 +22,4 @@ Metrics that can be calculated based on the data collected from Tapd:
## Configuration
- Configuring Teambition via [config-ui](/Configuration/Teambition.md).
-- Configuring Teambition via Config UI's [advanced mode](/Configuration/AdvancedMode.md#11-Teambition).
+- Configuring Teambition via Config UI's [advanced mode](/Configuration/AdvancedMode.md#11-teambition).