diff --git a/doc/user/group/insights/img/insights_example_stacked_bar_chart_v13_11.png b/doc/user/group/insights/img/insights_example_stacked_bar_chart_v13_11.png deleted file mode 100644 index ff18a3e86a5c7fc205594ff96d20dbf13b8b0092..0000000000000000000000000000000000000000 Binary files a/doc/user/group/insights/img/insights_example_stacked_bar_chart_v13_11.png and /dev/null differ diff --git a/doc/user/group/insights/img/insights_example_stacked_bar_chart_v15_4.png b/doc/user/group/insights/img/insights_example_stacked_bar_chart_v15_4.png new file mode 100644 index 0000000000000000000000000000000000000000..f7963c170e131d7add0d6f043179bd9a4ac63272 Binary files /dev/null and b/doc/user/group/insights/img/insights_example_stacked_bar_chart_v15_4.png differ diff --git a/doc/user/group/insights/index.md b/doc/user/group/insights/index.md index c9911fc5efa41684a5691dd372cf76f3cd84cc3b..0c1c4ef644f033258106afc9c86aba692541a77e 100644 --- a/doc/user/group/insights/index.md +++ b/doc/user/group/insights/index.md @@ -8,11 +8,12 @@ info: To determine the technical writer assigned to the Stage/Group associated w > [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/725) in GitLab 12.0. -Configure Insights to explore data about you group's activity, such as +Configure insights to explore data about you group's activity, such as triage hygiene, issues created or closed in a given period, and average time for merge requests to be merged. +You can also create custom insights reports that are relevant for your group. -## View your group's Insights +## View group insights Prerequisites: @@ -20,20 +21,47 @@ Prerequisites: - You must have access to a project to view information about its merge requests and issues, and permission to view them if they are confidential. -To access your group's Insights: +To access your group's insights: 1. On the top bar, select **Main menu > Groups** and find your group. 1. On the left sidebar, select **Analytics > Insights**. -![Insights example stacked bar chart](img/insights_example_stacked_bar_chart_v13_11.png) +## Interact with insights charts -## Configure your Insights +You can interact with the insights charts to view details about your group's activity. -GitLab reads Insights from the +![Insights example stacked bar chart](img/insights_example_stacked_bar_chart_v15_4.png) + +### Display different reports + +To display one of the available reports on the insights page, from the **Select report** dropdown list, +select the report you want to display. + +### View bar chart annotations + +To view annotations, hover over each bar in the chart. + +### Zoom in on chart + +Insights display data from the last 90 days. You can zoom in to display data only from a subset of the 90-day range. + +To do this, select the pause icons (**{status-paused}**) and slide them along the horizontal axis: + +- To select a later start date, slide the left pause icon to the right. +- To select an earlier end date, slide the right pause icon to the left. + +### Exclude dimensions from charts + +By default, insights display all available dimensions on the chart. + +To exclude a dimension, from the legend below the chart, select the name of the dimension. + +## Configure group insights + +GitLab reads insights from the [default configuration file](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/fixtures/insights/default.yml). -You can also create custom Insights charts that are more relevant for your group. -To customize your Insights: +To configure group insights: 1. Create a new file [`.gitlab/insights.yml`](../../project/insights/index.md#configure-project-insights) in a project that belongs to your group. diff --git a/doc/user/project/insights/index.md b/doc/user/project/insights/index.md index 8e08d82c0671088385566d6dee55c4bad7905046..af883ed9a79231c5b4479df885b7fb2a7edb883e 100644 --- a/doc/user/project/insights/index.md +++ b/doc/user/project/insights/index.md @@ -34,7 +34,7 @@ Prerequisites: - Depending on your project configuration, you must have at least the Developer role. -Project insights are configured with the [`.gitlab/insights.yml`](#insights-configuration-file) file in the project. If a project doesn't have a configuration file, it uses the [group configuration](../../group/insights/index.md#configure-your-insights). +Project insights are configured with the [`.gitlab/insights.yml`](#insights-configuration-file) file in the project. If a project doesn't have a configuration file, it uses the [group configuration](../../group/insights/index.md#configure-group-insights). The `.gitlab/insights.yml` file is a YAML file where you define: @@ -52,7 +52,7 @@ To configure project insights, either: 1. Select **Commit changes**. After you create the configuration file, you can also -[use it for the project's group](../../group/insights/index.md#configure-your-insights). +[use it for the project's group](../../group/insights/index.md#configure-group-insights). ## Insights configuration file @@ -396,7 +396,7 @@ Use `query.environment_tiers` to define an array of environments to include the Use `projects` to limit where issuables are queried from: -- If `.gitlab/insights.yml` is used for a [group's insights](../../group/insights/index.md#configure-your-insights), use `projects` to define the projects from which to query issuables. By default, all projects under the group are used. +- If `.gitlab/insights.yml` is used for a [group's insights](../../group/insights/index.md#configure-group-insights), use `projects` to define the projects from which to query issuables. By default, all projects under the group are used. - If `.gitlab/insights.yml` is used for a project's insights, specifying other projects does not yield results. By default, the project is used. #### `projects.only`