Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added supported sources section for all pages and updated introduction doc #592

Merged
merged 11 commits into from
Jul 26, 2023
5 changes: 5 additions & 0 deletions docs/Plugins/bitbucket.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ This plugin collects various entities from Bitbucket, including pull requests, i

As of v0.14.2, `bitbucket` plugin can only be invoked through DevLake API. Its support in Config-UI is WIP.

## Supported Versions

Available for BitBucket Cloud. Check [this doc](https://devlake.apache.org/docs/Overview/SupportedDataSources#data-sources-and-data-plugins) for more details.


## Entities

Check out the [BitBucket entities](/Overview/SupportedDataSources.md#data-collection-scope-by-each-plugin) collected by this plugin.
Expand Down
3 changes: 3 additions & 0 deletions docs/Plugins/feishu.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ description: >

This plugin collects Feishu meeting data through [Feishu Openapi](https://open.feishu.cn/document/home/user-identity-introduction/introduction).

## Supported Versions
Available for all versions

## Configuration

In order to fully use this plugin, you will need to get `app_id` and `app_secret` from a Feishu administrator (for help on App info, please see [official Feishu Docs](https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/tenant_access_token_internal)),
Expand Down
4 changes: 4 additions & 0 deletions docs/Plugins/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ This plugin collects GitHub data through [REST API](https://docs.github.com/en/r
- How fast do we respond to customer requirements?
- Was our quality improved or not?

## Supported Versions

Available for GitHub Cloud.

## Entities

Check out the [GitHub entities](/Overview/SupportedDataSources.md#data-collection-scope-by-each-plugin) collected by this plugin.
Expand Down
4 changes: 4 additions & 0 deletions docs/Plugins/gitlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ This plugin collects GitLab data through [API](https://docs.gitlab.com/ee/api/).
- How long does it take for your codes to get merged?
- How much time is spent on code review?

## Supported Versions

Available for GitLab Cloud, Community Edition 11+. Check [this doc](https://devlake.apache.org/docs/Overview/SupportedDataSources#data-sources-and-data-plugins) for more details.

## Entities

Check out the [GitLab entities](/Overview/SupportedDataSources.md#data-collection-scope-by-each-plugin) collected by this plugin.
Expand Down
4 changes: 4 additions & 0 deletions docs/Plugins/jenkins.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ This plugin collects Jenkins data through [Remote Access API](https://www.jenkin
- What is the build success rate?
- How long does it take for a code change to be deployed into production?

## Supported Versions

Available for Jenkins v2.263.x+. Check [this doc](https://devlake.apache.org/docs/Overview/SupportedDataSources#data-sources-and-data-plugins) for more details.

### Note

Please note that it is important to avoid [rerunning Jenkins builds in place](https://www.jenkins.io/doc/pipeline/tour/running-multiple-steps/#timeouts-retries-and-more), and instead ensure that each rerun has a unique build number. This is because rerunning builds with the same build number can lead to inconsistencies in the data collected by the Jenkins plugin.
Expand Down
3 changes: 3 additions & 0 deletions docs/Plugins/jira.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ description: >

This plugin collects Jira data through Jira REST API. It then computes and visualizes various engineering metrics from the Jira data.

## Supported Versions
Available for all versions

## Entities

Check out the [Jira entities](/Overview/SupportedDataSources.md#data-collection-scope-by-each-plugin) collected by this plugin.
Expand Down
5 changes: 3 additions & 2 deletions docs/Plugins/pagerduty.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ description: >
PagerDuty Plugin
---



## Summary

This plugin collects all incidents from PagerDuty, and uses them to compute incident-type DORA metrics. Namely,
Expand All @@ -14,6 +12,9 @@ This plugin collects all incidents from PagerDuty, and uses them to compute inci
* [Incident Age](/Metrics/IncidentAge.md)
* [Incident Count Per 1k Lines of Code](/Metrics/IncidentCountPer1kLinesOfCode.md)

## Supported Versions
Available for PagerDuty Cloud.


## Configuration
* Configure PagerDuty via Config UI. See instructions [here](/Configuration/PagerDuty.md).
Expand Down
4 changes: 4 additions & 0 deletions docs/Plugins/sonarqube.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ description: >
This plugin collects SonarQube data through its REST APIs. SonarQube is a tool for static code analysis and code quality management. It can help you discover potential problems and defects in your code, and provide suggestions and solutions.
(Please note that this version of SonarQube cannot collect issues with more than 10k+)

## Supported Versions

Available for SonarQube Server v8.x, v9.x. Check [this doc](https://devlake.apache.org/docs/Overview/SupportedDataSources#data-sources-and-data-plugins) for more details.

## Entities

Check out the [SonarQube entities](/Overview/SupportedDataSources.md#data-collection-scope-by-each-plugin) collected by this plugin.
Expand Down
3 changes: 3 additions & 0 deletions docs/Plugins/tapd.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ description: >

This plugin collects TAPD data through its REST APIs. TAPD is an issue-tracking tool similar to Jira.

## Supported Versions
Available for all versions
JoshuaPoddoku marked this conversation as resolved.
Show resolved Hide resolved

## Metrics

Metrics that can be calculated based on the data collected from Tapd:
Expand Down
4 changes: 4 additions & 0 deletions docs/Plugins/zentao.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ description: >

This plugin collects Zentao data through its REST APIs. [Zentao](https://github.com/easysoft/zentaopms) is an issue-tracking tool similar to Jira.

## Supported Versions

Available for Zentao OSS v18.3, Enterprise v8.2, Flagship v4.3. Check [this doc](https://devlake.apache.org/docs/Overview/SupportedDataSources#data-sources-and-data-plugins) for more details.

## Metrics

Metrics that can be calculated based on the data collected from Zentao:
Expand Down
6 changes: 3 additions & 3 deletions src/components/Sections/WhyDevlake.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -102,10 +102,10 @@ function Supports() {
className="text-label18 font-inter text-neutral-500 mt-6
sm:text-label16 sm:mt-4"
>
Check out all {" "}
<C.InlineLink link="https://devlake.apache.org/docs/Overview/Roadmap">
JoshuaPoddoku marked this conversation as resolved.
Show resolved Hide resolved
More data sources
</C.InlineLink>{" "}
coming soon...
supported data sources
</C.InlineLink>
</div>
</div>
);
Expand Down