diff options
author | Achilleas Pipinellis <axil@gitlab.com> | 2019-05-21 16:30:28 +0000 |
---|---|---|
committer | Achilleas Pipinellis <axil@gitlab.com> | 2019-05-21 16:30:28 +0000 |
commit | b3a2d8d695dd7e1296a75a237e4a4462b5ef1df8 (patch) | |
tree | 262cbdbbc8a40181dc13314470779428c14e6bfc /doc/user | |
parent | f66aa212fe5f3ad0ea536958fd8de084252c29f8 (diff) | |
parent | 333c661031794894b35cb95fba3f81cb43871c46 (diff) | |
download | gitlab-ce-b3a2d8d695dd7e1296a75a237e4a4462b5ef1df8.tar.gz |
Merge branch 'docs-improve-insights-documentation' into 'master'
Document how to access the Insights page
See merge request gitlab-org/gitlab-ce!28488
Diffstat (limited to 'doc/user')
-rw-r--r-- | doc/user/group/insights/img/insights_sidebar_link.png | bin | 0 -> 18826 bytes | |||
-rw-r--r-- | doc/user/group/insights/index.md | 11 | ||||
-rw-r--r-- | doc/user/project/insights/img/insights_sidebar_link.png | bin | 0 -> 21463 bytes | |||
-rw-r--r-- | doc/user/project/insights/index.md | 16 |
4 files changed, 20 insertions, 7 deletions
diff --git a/doc/user/group/insights/img/insights_sidebar_link.png b/doc/user/group/insights/img/insights_sidebar_link.png Binary files differnew file mode 100644 index 00000000000..64bbd1fc4d3 --- /dev/null +++ b/doc/user/group/insights/img/insights_sidebar_link.png diff --git a/doc/user/group/insights/index.md b/doc/user/group/insights/index.md index 5283d8da77d..20f76c54ae7 100644 --- a/doc/user/group/insights/index.md +++ b/doc/user/group/insights/index.md @@ -4,8 +4,8 @@ CAUTION: **Beta:** Insights is considered beta, and is not ready for production use. -Follow [gitlab-org&725](https://gitlab.com/groups/gitlab-org/-/epics/725) for -updates. +Follow [gitlab-org/quality/team-tasks#137](https://gitlab.com/gitlab-org/quality/team-tasks/issues/137#general-availability) +for updates. Configure the Insights that matter for your groups to explore data such as triage hygiene, issues created/closed per a given period, average time for merge @@ -13,6 +13,13 @@ requests to be merged and much more. ![Insights example stacked bar chart](img/insights_example_stacked_bar_chart.png) +## View your group's Insights + +You can access your group's Insights by clicking the **Overview > Insights** +link in the left sidebar: + +![Insights sidebar link](img/insights_sidebar_link.png) + ## Configure your Insights Navigate to your group's **Settings > General**, expand **Insights**, and choose diff --git a/doc/user/project/insights/img/insights_sidebar_link.png b/doc/user/project/insights/img/insights_sidebar_link.png Binary files differnew file mode 100644 index 00000000000..aadb5745992 --- /dev/null +++ b/doc/user/project/insights/img/insights_sidebar_link.png diff --git a/doc/user/project/insights/index.md b/doc/user/project/insights/index.md index 720f4c6604e..b6cc1862cc2 100644 --- a/doc/user/project/insights/index.md +++ b/doc/user/project/insights/index.md @@ -4,18 +4,25 @@ CAUTION: **Beta:** Insights is considered beta, and is not ready for production use. -Follow [gitlab-org&725](https://gitlab.com/groups/gitlab-org/-/epics/725) for -updates. +Follow [gitlab-org/quality/team-tasks#137](https://gitlab.com/gitlab-org/quality/team-tasks/issues/137#general-availability) +for updates. Configure the Insights that matter for your projects to explore data such as triage hygiene, issues created/closed per a given period, average time for merge requests to be merged and much more. -![Insights example stacked bar chart](img/project_insights.png) +![Insights example bar chart](img/project_insights.png) NOTE: **Note:** This feature is [also available at the group level](https://docs.gitlab.com/ee/user/group/insights/index.html). +## View your project's Insights + +You can access your project's Insights by clicking the **Project > Insights** +link in the left sidebar: + +![Insights sidebar link](img/insights_sidebar_link.png) + ## Configure your Insights Insights are configured using a YAML file called `.gitlab/insights.yml` within @@ -74,8 +81,7 @@ Each chart definition is made up of a hash composed of key-value pairs. For example, here's single chart definition: ```yaml -monthlyBugsCreated: - title: Monthly Bugs Created (bar) +- title: Monthly Bugs Created (bar) type: bar query: issuable_type: issue |