Startrekzky commented on code in PR #354: URL: https://github.com/apache/incubator-devlake-website/pull/354#discussion_r1056285622
########## docs/Plugins/gitlab.md: ########## @@ -4,42 +4,71 @@ description: > GitLab Plugin --- +## Summary + +This plugin gathers data from `Gitlab` to display information to the user in `Grafana`. We can help tech leaders answer such questions as: + +- Is this month more productive than last? +- Was our quality improved or not? + Review Comment: Add two questions: - How long does it take for your codes to get merged? - How much time is spent on code review? ########## docs/Plugins/gitlab.md: ########## @@ -4,42 +4,71 @@ description: > GitLab Plugin --- +## Summary + +This plugin gathers data from `Gitlab` to display information to the user in `Grafana`. We can help tech leaders answer such questions as: + +- Is this month more productive than last? +- Was our quality improved or not? + +## Entities + +Check out the [Gitlab entities](/Overview/SupportedDataSources.md#data-collection-scope-by-each-plugin) collected by this plugin. Review Comment: Use GitLab ########## docs/Plugins/jenkins.md: ########## @@ -8,41 +8,56 @@ description: > This plugin collects Jenkins data through [Remote Access API](https://www.jenkins.io/doc/book/using/remote-access-api/). It then computes and visualizes various DevOps metrics from the Jenkins data. - +## Entities -## Metrics +Check out the [Jenkins entities](/Overview/SupportedDataSources.md#data-collection-scope-by-each-plugin) collected by this plugin. -| Metric Name | Description | -|:-------------------|:------------------------------------| -| Build Count | The number of builds created | -| Build Success Rate | The percentage of successful builds | +## Data Refresh Policy -## Configuration +Check out the [data refresh policy](/Overview/SupportedDataSources.md#jenkins) of this plugin. -In order to fully use this plugin, you will need to set various configurations via Dev Lake's `config-ui`. +## Metrics -### By `config-ui` +Metrics that can be calculated based on the data collected from Jenkins: -The connection section of the configuration screen requires the following key fields to connect to the Jenkins API. +- [Build Count](/Metrics/BuildCount.md) +- [Build Duration](/Metrics/BuildDuration.md) +- [Build Success Rate](/Metrics/BuildSuccessRate.md) Review Comment: It also calculates four DORA metrics. ########## docs/Plugins/gitlab.md: ########## @@ -4,42 +4,71 @@ description: > GitLab Plugin --- +## Summary + +This plugin gathers data from `Gitlab` to display information to the user in `Grafana`. We can help tech leaders answer such questions as: Review Comment: Text change: 1. from `GitLab` 2. in Grafana 3. It helps tech leads, QA and DevOps engineers, and project managers to answer questions such as: ########## docs/Plugins/gitlab.md: ########## @@ -4,42 +4,71 @@ description: > GitLab Plugin --- +## Summary + +This plugin gathers data from `Gitlab` to display information to the user in `Grafana`. We can help tech leaders answer such questions as: + +- Is this month more productive than last? +- Was our quality improved or not? + +## Entities + +Check out the [Gitlab entities](/Overview/SupportedDataSources.md#data-collection-scope-by-each-plugin) collected by this plugin. + +## Data Refresh Policy + +Check out the [data refresh policy](/Overview/SupportedDataSources.md#gitlab) of this plugin. ## Metrics -| Metric Name | Description | -|:----------------------------|:-------------------------------------------------------------| -| Pull Request Count | Number of Pull/Merge Requests | -| Pull Request Pass Rate | Ratio of Pull/Merge Review requests to merged | -| Pull Request Reviewer Count | Number of Pull/Merge Reviewers | -| Pull Request Review Time | Time from Pull/Merge created time until merged | -| Commit Author Count | Number of Contributors | -| Commit Count | Number of Commits | -| Added Lines | Accumulated Number of New Lines | -| Deleted Lines | Accumulated Number of Removed Lines | -| Pull Request Review Rounds | Number of cycles of commits followed by comments/final merge | +Metrics that can be calculated based on the data collected from Gitlab: + +- [Requirement Count](/Metrics/RequirementCount.md) +- [PR Merge Rate](/Metrics/PRMergeRate.md) Review Comment: All these metrics can be calculated. 1. Explain that PR-related metrics are calculated by GitLab MRs. DevLake uses PR to unify the naming of GitHub PRs, BitBucket PRs, Azure DevOps PRs, and GitLab MRs. 2. Explain that GitLab CI jobs can be used in calculating DORA metrics, if `deployments` are performed through GitLab CI.  -- 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]
