diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-05-13 12:10:44 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-05-13 12:10:44 +0300 |
commit | 19325d74c2a5e7f367c6d1d6a064650f90a5b3e7 (patch) | |
tree | 89801bfd3524ac992407048bc1cd2d3f233e50c7 /doc/user/group/value_stream_analytics | |
parent | a9c127515a36f928544b18ddd69e8b2dc6236aba (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user/group/value_stream_analytics')
12 files changed, 5 insertions, 84 deletions
diff --git a/doc/user/group/value_stream_analytics/img/delete_value_stream_v13_12.png b/doc/user/group/value_stream_analytics/img/delete_value_stream_v13_12.png Binary files differnew file mode 100644 index 00000000000..c02f259ae8c --- /dev/null +++ b/doc/user/group/value_stream_analytics/img/delete_value_stream_v13_12.png diff --git a/doc/user/group/value_stream_analytics/img/delete_value_stream_v13_4.png b/doc/user/group/value_stream_analytics/img/delete_value_stream_v13_4.png Binary files differdeleted file mode 100644 index c97fcb76343..00000000000 --- a/doc/user/group/value_stream_analytics/img/delete_value_stream_v13_4.png +++ /dev/null diff --git a/doc/user/group/value_stream_analytics/img/label_based_stage_vsm_v12_9.png b/doc/user/group/value_stream_analytics/img/label_based_stage_vsm_v12_9.png Binary files differdeleted file mode 100644 index 84ce33aece5..00000000000 --- a/doc/user/group/value_stream_analytics/img/label_based_stage_vsm_v12_9.png +++ /dev/null diff --git a/doc/user/group/value_stream_analytics/img/new_value_stream_v13_12.png b/doc/user/group/value_stream_analytics/img/new_value_stream_v13_12.png Binary files differnew file mode 100644 index 00000000000..b2b6ce04a14 --- /dev/null +++ b/doc/user/group/value_stream_analytics/img/new_value_stream_v13_12.png diff --git a/doc/user/group/value_stream_analytics/img/new_value_stream_v13_3.png b/doc/user/group/value_stream_analytics/img/new_value_stream_v13_3.png Binary files differdeleted file mode 100644 index bc8502e85a6..00000000000 --- a/doc/user/group/value_stream_analytics/img/new_value_stream_v13_3.png +++ /dev/null diff --git a/doc/user/group/value_stream_analytics/img/new_vsm_stage_v12_9.png b/doc/user/group/value_stream_analytics/img/new_vsm_stage_v12_9.png Binary files differdeleted file mode 100644 index dbef25d33ed..00000000000 --- a/doc/user/group/value_stream_analytics/img/new_vsm_stage_v12_9.png +++ /dev/null diff --git a/doc/user/group/value_stream_analytics/img/vsa_filter_bar_v13_12.png b/doc/user/group/value_stream_analytics/img/vsa_filter_bar_v13_12.png Binary files differnew file mode 100644 index 00000000000..ee0d007a778 --- /dev/null +++ b/doc/user/group/value_stream_analytics/img/vsa_filter_bar_v13_12.png diff --git a/doc/user/group/value_stream_analytics/img/vsa_filter_bar_v13_3.png b/doc/user/group/value_stream_analytics/img/vsa_filter_bar_v13_3.png Binary files differdeleted file mode 100644 index 506765f63cb..00000000000 --- a/doc/user/group/value_stream_analytics/img/vsa_filter_bar_v13_3.png +++ /dev/null diff --git a/doc/user/group/value_stream_analytics/img/vsa_time_metrics_v13_0.png b/doc/user/group/value_stream_analytics/img/vsa_time_metrics_v13_0.png Binary files differdeleted file mode 100644 index 799a81584a0..00000000000 --- a/doc/user/group/value_stream_analytics/img/vsa_time_metrics_v13_0.png +++ /dev/null diff --git a/doc/user/group/value_stream_analytics/img/vsa_time_metrics_v13_12.png b/doc/user/group/value_stream_analytics/img/vsa_time_metrics_v13_12.png Binary files differnew file mode 100644 index 00000000000..63bae51afef --- /dev/null +++ b/doc/user/group/value_stream_analytics/img/vsa_time_metrics_v13_12.png diff --git a/doc/user/group/value_stream_analytics/img/vsm_stage_list_v12_9.png b/doc/user/group/value_stream_analytics/img/vsm_stage_list_v12_9.png Binary files differdeleted file mode 100644 index 3b50dd48543..00000000000 --- a/doc/user/group/value_stream_analytics/img/vsm_stage_list_v12_9.png +++ /dev/null diff --git a/doc/user/group/value_stream_analytics/index.md b/doc/user/group/value_stream_analytics/index.md index 132cf3b17d2..023eddfddd5 100644 --- a/doc/user/group/value_stream_analytics/index.md +++ b/doc/user/group/value_stream_analytics/index.md @@ -59,7 +59,7 @@ To filter results: 1. Select a parameter to filter by. 1. Select a value from the autocompleted results, or type to refine the results. -![Value stream analytics filter bar](img/vsa_filter_bar_v13_3.png "Active filter bar for value stream analytics") +![Value stream analytics filter bar](img/vsa_filter_bar_v13_12.png "Active filter bar for value stream analytics") ### Date ranges @@ -92,7 +92,7 @@ keep this slight change in mind. You can learn more about these metrics in our [analytics definitions](../../analytics/index.md). -![Value stream analytics time metrics](img/vsa_time_metrics_v13_0.png "Time metrics for value stream analytics") +![Value stream analytics time metrics](img/vsa_time_metrics_v13_12.png "Time metrics for value stream analytics") ## How the stages are measured @@ -124,7 +124,7 @@ How this works, behind the scenes: etc. To sum up, anything that doesn't follow [GitLab flow](../../../topics/gitlab_flow.md) is not tracked and the -Value Stream Analytics dashboard doesn not present any data for: +Value Stream Analytics dashboard does not present any data for: - Merge requests that do not close an issue. - Issues not labeled with a label present in the Issue Board or for issues not assigned a milestone. @@ -271,85 +271,6 @@ To see which items the stage most recently, sort by the work item column on the The table displays up to 20 items at a time. If there are more than 20 items, you can use the **Prev** and **Next** buttons to navigate through the pages. -### Adding a stage - -In the following example we're creating a new stage that measures and tracks issues from creation -time until they are closed. - -1. Navigate to your group's **Analytics > Value Stream**. -1. Click the **Add a stage** button. -1. Fill in the new stage form: - - Name: Issue start to finish. - - Start event: Issue created. - - End event: Issue closed. -1. Click the **Add stage** button. - -![New Value Stream Analytics Stage](img/new_vsm_stage_v12_9.png "Form for creating a new stage") - -The new stage is persisted and it will always show up on the Value Stream Analytics page for your -group. - -If you want to alter or delete the stage, you can easily do that for customized stages by: - -1. Hovering over the stage. -1. Clicking the vertical ellipsis (**{ellipsis_v}**) button that appears. - -![Value Stream Analytics Stages](img/vsm_stage_list_v12_9.png) - -Creating a custom stage requires specifying two events: - -- A start. -- An end. - -Be careful to choose a start event that occurs *before* your end event. For example, consider a -stage that: - -- Started when an issue is added to a board. -- Ended when the issue is created. - -This stage would not work because the end event has already happened when the start event occurs. -To prevent such invalid stages, the UI prohibits incompatible start and end events. After you select -the start event, the stop event dropdown will only list the compatible events. - -### Re-ordering stages - -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/196698) in GitLab 12.10. - -Once a custom stage has been added, you can "drag and drop" stages to rearrange their order. These -changes are automatically saved to the system. - -### Label based stages - -The pre-defined start and end events can cover many use cases involving both issues and merge requests. - -For supporting more complex workflows, use stages based on group labels. These events are based on -labels being added or removed. In particular, [scoped labels](../../project/labels.md#scoped-labels) -are useful for complex workflows. - -In this example, we'd like to measure more accurate code review times. The workflow is the following: - -- When the code review starts, the reviewer adds `workflow::code_review_start` label to the merge request. -- When the code review is finished, the reviewer adds `workflow::code_review_complete` label to the merge request. - -Creating a new stage called "Code Review": - -![New Label Based Value Stream Analytics Stage](img/label_based_stage_vsm_v12_9.png "Creating a label based Value Stream Analytics Stage") - -### Hiding unused stages - -Sometimes certain default stages are not relevant to a team. In this case, you can easily hide stages -so they no longer appear in the list. To hide stages: - -1. Add a custom stage to activate customizability. -1. Hover over the default stage you want to hide. -1. Click the vertical ellipsis (**{ellipsis_v}**) button that appears and select **Hide stage**. - -To recover a default stage that was previously hidden: - -1. Click **Add a stage** button. -1. In the top right corner open the **Recover hidden stage** dropdown. -1. Select a stage. - ### Creating a value stream > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/221202) in GitLab 13.3 @@ -369,7 +290,7 @@ To create a value stream: - You can [customize the stages](#creating-a-value-stream-with-stages) 1. Click the **Create Value Stream** button. -![New value stream](img/new_value_stream_v13_3.png "Creating a new value stream") +![New value stream](img/new_value_stream_v13_12.png "Creating a new value stream") #### Creating a value stream with stages @@ -406,7 +327,7 @@ To delete a custom value stream: 1. Click the **Delete (name of value stream)**. 1. Click the **Delete** button to confirm. -![Delete value stream](img/delete_value_stream_v13_4.png "Deleting a custom value stream") +![Delete value stream](img/delete_value_stream_v13_12.png "Deleting a custom value stream") ## Days to completion chart |