From e3fa463d1b1946082266d923576053f8f3341fc1 Mon Sep 17 00:00:00 2001 From: Eric Brinkman Date: Mon, 25 Feb 2019 19:29:33 +0000 Subject: Update Cycle Analytics documentation Removed duplicate info. Update pipeline health to cycle analytics. Updated screenshots. --- app/views/projects/cycle_analytics/show.html.haml | 2 +- doc/user/project/cycle_analytics.md | 37 +++++++++------------ .../project/img/cycle_analytics_landing_page.png | Bin 42114 -> 184131 bytes locale/gitlab.pot | 6 ++-- 4 files changed, 20 insertions(+), 25 deletions(-) diff --git a/app/views/projects/cycle_analytics/show.html.haml b/app/views/projects/cycle_analytics/show.html.haml index bdf021fd87f..59f0afd59e6 100644 --- a/app/views/projects/cycle_analytics/show.html.haml +++ b/app/views/projects/cycle_analytics/show.html.haml @@ -10,7 +10,7 @@ .wrapper{ "v-show" => "!isLoading && !hasError" } .card .card-header - {{ __('Pipeline Health') }} + {{ __('Recent Project Activity') }} .content-block .container-fluid .row diff --git a/doc/user/project/cycle_analytics.md b/doc/user/project/cycle_analytics.md index 05127b274e0..19ab911e39f 100644 --- a/doc/user/project/cycle_analytics.md +++ b/doc/user/project/cycle_analytics.md @@ -3,45 +3,40 @@ > [Introduced][ce-5986] in GitLab 8.12. Further features were added in GitLab 8.14. -Cycle Analytics measures the time it takes to go from an [idea to production] for -each project you have. This is achieved by not only indicating the total time it -takes to reach that point, but the total time is broken down into the -multiple stages an idea has to pass through to be shipped. +Cycle Analytics measures the time spent to go from an [idea to production] for +each of your projects. Cycle Analytics displays the median time for an idea to +reach production, along with the time typically spent in each DevOps stage along the way. + +Cycle Analytics is useful in order to quickly determine the velocity of a given +project. It points to bottlenecks in the development process, enabling management +to uncover, triage, and root-cause slowdowns in the software development life cycle. Cycle Analytics is tightly coupled with the [GitLab flow] and calculates a separate median for each stage. ## Overview -You can find the Cycle Analytics page under your project's **Pipelines ➔ Cycle +You can find the Cycle Analytics page under your project's **Project ➔ Cycle Analytics** tab. ![Cycle Analytics landing page](img/cycle_analytics_landing_page.png) -You can see that there are seven stages in total: +There are seven stages that are tracked as part of the Cycle Analytics calculations. - **Issue** (Tracker) - - Median time from issue creation until given a milestone or list label - (first assignment, any milestone, milestone date or assignee is not required) + - Time to schedule an issue (by milestone or by adding it to an issue board) - **Plan** (Board) - - Median time from giving an issue a milestone or label until pushing the - first commit to the branch + - Time to first commit - **Code** (IDE) - - Median time from the first commit to the branch until the merge request is - created + - Time to create a merge request - **Test** (CI) - - Median total test time for all commits/merges + - Time it takes GitLab CI/CD to test your code - **Review** (Merge Request/MR) - - Median time from merge request creation until the merge request is merged - (closed merge requests won't be taken into account) + - Time spent on code review - **Staging** (Continuous Deployment) - - Median time from when the merge request got merged until the deploy to - production (production is last stage/environment) + - Time between merging and deploying to production - **Production** (Total) - - Sum of all the above stages' times excluding the Test (CI) time. To clarify, - it's not so much that CI time is "excluded", but rather CI time is already - counted in the review stage since CI is done automatically. Most of the - other stages are purely sequential, but **Test** is not. + - Total lifecycle time; i.e. the velocity of the project or team ## How the data is measured diff --git a/doc/user/project/img/cycle_analytics_landing_page.png b/doc/user/project/img/cycle_analytics_landing_page.png index 8b17fae5e05..cf46098b9a4 100644 Binary files a/doc/user/project/img/cycle_analytics_landing_page.png and b/doc/user/project/img/cycle_analytics_landing_page.png differ diff --git a/locale/gitlab.pot b/locale/gitlab.pot index 8d2799a1aab..1c5b89f16e0 100644 --- a/locale/gitlab.pot +++ b/locale/gitlab.pot @@ -5413,9 +5413,6 @@ msgstr "" msgid "Pipeline" msgstr "" -msgid "Pipeline Health" -msgstr "" - msgid "Pipeline Schedule" msgstr "" @@ -6202,6 +6199,9 @@ msgstr "" msgid "Real-time features" msgstr "" +msgid "Recent Project Activity" +msgstr "" + msgid "Recent searches" msgstr "" -- cgit v1.2.1