kotovalexarian-likes-gitlab
/
gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity

Merge branch 'docs-improve-insights-documentation' into 'master' 

Document how to access the Insights page

See merge request gitlab-org/gitlab-ce!28488
This commit is contained in:
Achilleas Pipinellis 2019-05-21 16:30:28 +00:00
parent f66aa212fe 333c661031
commit b3a2d8d695
4 changed files with 20 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/user/group/insights/img/insights_sidebar_link.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 18 KiB

11
doc/user/group/insights/index.md
View File

@ -4,8 +4,8 @@
CAUTION: **Beta:** CAUTION: **Beta:**
Insights is considered beta, and is not ready for production use. Insights is considered beta, and is not ready for production use.
Follow [gitlab-org&725](https://gitlab.com/groups/gitlab-org/-/epics/725) for Follow [gitlab-org/quality/team-tasks#137](https://gitlab.com/gitlab-org/quality/team-tasks/issues/137#general-availability)
updates. for updates.
Configure the Insights that matter for your groups to explore data such as 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 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) ![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 ## Configure your Insights
Navigate to your group's **Settings > General**, expand **Insights**, and choose Navigate to your group's **Settings > General**, expand **Insights**, and choose

BIN
doc/user/project/insights/img/insights_sidebar_link.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 21 KiB

16
doc/user/project/insights/index.md
View File

@ -4,18 +4,25 @@
CAUTION: **Beta:** CAUTION: **Beta:**
Insights is considered beta, and is not ready for production use. Insights is considered beta, and is not ready for production use.
Follow [gitlab-org&725](https://gitlab.com/groups/gitlab-org/-/epics/725) for Follow [gitlab-org/quality/team-tasks#137](https://gitlab.com/gitlab-org/quality/team-tasks/issues/137#general-availability)
updates. for updates.
Configure the Insights that matter for your projects to explore data such as 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 triage hygiene, issues created/closed per a given period, average time for merge
requests to be merged and much more. 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:** NOTE: **Note:**
This feature is [also available at the group level](https://docs.gitlab.com/ee/user/group/insights/index.html). 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 ## Configure your Insights
Insights are configured using a YAML file called `.gitlab/insights.yml` within 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: For example, here's single chart definition:
```yaml ```yaml
monthlyBugsCreated: - title: Monthly Bugs Created (bar)
title: Monthly Bugs Created (bar)
type: bar type: bar
query: query:
issuable_type: issue issuable_type: issue