diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-01-18 03:09:18 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-01-18 03:09:18 +0300 |
commit | a1565a8243dd2cce29d0489d5ed40f9291d828d4 (patch) | |
tree | ed32d41117be241062ce5fd6a9576ed8a99fcffc /doc/user/analytics | |
parent | 40254b9ace2a74a3c9f1cc51a1b1d5e3e78c1ae9 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user/analytics')
-rw-r--r-- | doc/user/analytics/code_review_analytics.md | 35 | ||||
-rw-r--r-- | doc/user/analytics/index.md | 2 |
2 files changed, 37 insertions, 0 deletions
diff --git a/doc/user/analytics/code_review_analytics.md b/doc/user/analytics/code_review_analytics.md new file mode 100644 index 00000000000..87c29c265bf --- /dev/null +++ b/doc/user/analytics/code_review_analytics.md @@ -0,0 +1,35 @@ +--- +description: "Learn how long your open merge requests have spent in code review, and what distinguishes the longest-running." # Up to ~200 chars long. They will be displayed in Google Search snippets. It may help to write the page intro first, and then reuse it here. +--- + +# Code Review Analytics **(STARTER)** + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/38062) in GitLab ([Starter](https://about.gitlab.com/pricing/)) 12.7. + +Want to learn how long your open merge requests have spent in code review? Or what distinguishes your longest-running code reviews? These are some of the questions Code Review Analytics is designed to answer. + +NOTE: **Note:** +Initially no data will appear. Data will populate as users comment on open merge requests. + +## Overview + +Code Review Analytics displays a collection of merge requests in a table. These are all the open merge requests that are considered to be in code review. This feature considers code review to begin when a merge request receives its first comment from someone other than the author. The rows of the table are sorted by review time so the longest reviews appear at the top. There are also columns to display the author, approvers, comment count, and line -/+ counts. + +This feature is designed for [development team leaders](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#delaney-development-team-lead) and others who want to understand broad code review dynamics, and identify patterns to help explain them. You can use Code Review Analytics to expose your team's unique challenges with code review, and identify improvements that might substantially accelerate your development cycle. + +## Use cases + +Perhaps your team agrees that code review is moving too slow, or the [Cycle Analytics feature](https://docs.gitlab.com/ee/user/analytics/cycle_analytics.html) shows that "Review" is your team's most time-consuming step. You can use Code Review Analytics to see what is currently moving slowest, and analyze the patterns and trends between them. Lots of comments or commits? Maybe the code is too complex. A particular author is involved? Maybe more training is advisable. Few comments and approvers? Maybe your team is understaffed. + +## Permissions + +- On [Starter or Bronze tier](https://about.gitlab.com/pricing/) and above. +- By users with [Reporter access] and above. + +## Feature flag + +Code Review Analytics is [currently protected by a feature flag](https://gitlab.com/gitlab-org/gitlab/issues/194165) that defaults to "enabled" - meaning the feature is available. If you experience performance problems or otherwise wish to disable the feature, a GitLab administrator can execute a command in a Rails console: + +```ruby +Feature.disable(:code_review_analytics) +``` diff --git a/doc/user/analytics/index.md b/doc/user/analytics/index.md index 8e88d8fd7b6..707ba01eb79 100644 --- a/doc/user/analytics/index.md +++ b/doc/user/analytics/index.md @@ -15,6 +15,8 @@ Once enabled, click on **Analytics** from the top navigation bar. From the centralized analytics workspace, the following analytics are available: +- [Code Review Analytics](code_review_analytics.md), enabled with the `code_review_analytics` + [feature flag](../../development/feature_flags/development.html#enabling-a-feature-flag-in-development). **(STARTER)** - [Cycle Analytics](cycle_analytics.md), enabled with the `cycle_analytics` [feature flag](../../development/feature_flags/development.html#enabling-a-feature-flag-in-development). **(PREMIUM)** - [Productivity Analytics](productivity_analytics.md), enabled with the `productivity_analytics` |