summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-09-15 18:09:43 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2020-09-15 18:09:43 +0000
commitf784f7d3b19fe80834240bde23d1300accb01118 (patch)
tree2acd4a74cbcde10c5b70c356b146af78362862d1 /doc
parent06c127aa72cff78235426341081837cff0b6f78b (diff)
downloadgitlab-ce-f784f7d3b19fe80834240bde23d1300accb01118.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r--doc/ci/examples/authenticating-with-hashicorp-vault/index.md2
-rw-r--r--doc/development/documentation/styleguide.md12
-rw-r--r--doc/user/analytics/code_review_analytics.md35
-rw-r--r--doc/user/analytics/value_stream_analytics.md16
4 files changed, 37 insertions, 28 deletions
diff --git a/doc/ci/examples/authenticating-with-hashicorp-vault/index.md b/doc/ci/examples/authenticating-with-hashicorp-vault/index.md
index 81f571dcb34..73896547675 100644
--- a/doc/ci/examples/authenticating-with-hashicorp-vault/index.md
+++ b/doc/ci/examples/authenticating-with-hashicorp-vault/index.md
@@ -47,7 +47,7 @@ The JWT's payload looks like this:
"project_path": "mygroup/myproject",
"user_id": "42",
"user_login": "myuser",
- "user_email": "myuser@example.com"
+ "user_email": "myuser@example.com",
"pipeline_id": "1212",
"job_id": "1212",
"ref": "auto-deploy-2020-04-01", # Git ref for this job
diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md
index d79054d197f..c3033f28928 100644
--- a/doc/development/documentation/styleguide.md
+++ b/doc/development/documentation/styleguide.md
@@ -626,6 +626,18 @@ For example:
cp <your_source_directory> <your_destination_directory>
```
+### Keyboard commands
+
+Use the HTML `<kbd>` tag when referring to keystroke presses. For example:
+
+```plaintext
+To stop the command, press <kbd>Ctrl</kbd>+<kbd>C</kbd>.
+```
+
+When the docs are generated, the output is:
+
+To stop the command, press <kbd>Ctrl</kbd>+<kbd>C</kbd>.
+
## Lists
- Always start list items with a capital letter, unless they are parameters or
diff --git a/doc/user/analytics/code_review_analytics.md b/doc/user/analytics/code_review_analytics.md
index 8c4c54153bb..89acb430a9f 100644
--- a/doc/user/analytics/code_review_analytics.md
+++ b/doc/user/analytics/code_review_analytics.md
@@ -10,40 +10,45 @@ info: To determine the technical writer assigned to the Stage/Group associated w
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/38062) in [GitLab Starter](https://about.gitlab.com/pricing/) 12.7.
-Code Review Analytics makes it easy to view the longest-running reviews among open merge requests,
-enabling you to take action on individual merge requests and reduce overall cycle time.
+Code Review Analytics makes it easy to view the longest-running reviews among open merge requests and
+enables you to:
+
+1. Take action on individual merge requests.
+1. Reduce overall cycle time.
NOTE: **Note:**
-Initially, no data will appear. Data is populated as users comment on open merge requests.
+Initially, no data appears. Data is populated as users comment on open merge requests.
## Overview
Code Review Analytics displays a table of open merge requests that have at least one non-author comment. The review time is measured from the time the first non-author comment was submitted.
-The code review period for a merge request is automatically identified as the time since the first non-author comment.
-To access Code Review Analytics, from your project's menu, go to **{chart}** **Project Analytics > Code Review**.
+To access Code Review Analytics, from your project's menu, go to **Project Analytics > Code Review**.
+
+You can filter the list of merge requests by milestone and label.
![Code Review Analytics](img/code_review_analytics_v12_8.png "List of code reviews; oldest review first.")
-- The table is sorted by review duration, helping you quickly find the longest-running reviews which may need intervention or to be broken down into smaller parts.
-- You can filter the list of MRs by milestone and label.
-- Columns to display the author, approvers, comment count, and line change (-/+) counts.
+The table is sorted by:
+
+- **Review time**: Helping you to quickly find the longest-running reviews which may need intervention
+ or to be broken down into smaller parts.
+- Other columns: Display the author, approvers, comment count, and line change (-/+) counts.
## Use cases
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.
+and others who want to understand broad code review dynamics, and identify patterns to explain them.
-Code Review Analytics can be used when:
+You can use Code Review Analytics to:
+- Expose your team's unique challenges with code review.
+- Identify improvements that might substantially accelerate your development cycle.
- Your team agrees that code review is moving too slow.
- The [Value Stream Analytics feature](value_stream_analytics.md) shows that reviews are your team's most time-consuming step.
+- Analyze the patterns and trends of different types of work that are moving slow.
-You can use Code Review Analytics to see the types of work that are currently moving the slowest, and analyze the patterns
-and trends between them. For example:
+For example:
- Lots of comments or commits? Maybe the code is too complex.
- A particular author is involved? Maybe more training is required.
diff --git a/doc/user/analytics/value_stream_analytics.md b/doc/user/analytics/value_stream_analytics.md
index 6e9dc582f87..504da36256e 100644
--- a/doc/user/analytics/value_stream_analytics.md
+++ b/doc/user/analytics/value_stream_analytics.md
@@ -337,7 +337,8 @@ Feature.disable(:value_stream_analytics_create_multiple_value_streams)
## Days to completion chart
-> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21631) in GitLab 12.6.
+> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21631) in GitLab 12.6.
+> - [Chart median line removed](https://gitlab.com/gitlab-org/gitlab/-/issues/235455) in GitLab 13.4.
This chart visually depicts the total number of days it takes for cycles to be completed.
@@ -345,15 +346,6 @@ This chart uses the global page filters for displaying data based on the selecte
group, projects, and timeframe. In addition, specific stages can be selected
from within the chart itself.
-### Chart median line
-
-> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/36675) in GitLab 12.7.
-
-The median line on the chart displays data that is offset by the number of days selected.
-For example, if 30 days worth of data has been selected (for example, 2019-12-16 to 2020-01-15) the
-median line will represent the previous 30 days worth of data (2019-11-16 to 2019-12-16)
-as a metric to compare against.
-
### Disabling chart
This chart is enabled by default. If you have a self-managed instance, an
@@ -363,9 +355,9 @@ administrator can open a Rails console and disable it with the following command
Feature.disable(:cycle_analytics_scatterplot_enabled)
```
-## Type of work - Tasks by type chart
+## Type of work - Tasks by type chart **(PREMIUM)**
-> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/32421) in GitLab 12.10.
+> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/32421) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.10.
This chart shows a cumulative count of issues and merge requests per day.