diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-02-28 18:09:07 +0000 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-02-28 18:09:07 +0000 |
| commit | 1c8fa70f9d0818e2a82089c8643a6e455bca47fd (patch) | |
| tree | f339f97de0425270bdd909e2f4d378927b6e0a18 /doc/user/project/insights/index.md | |
| parent | 736d36d8597d0d1ec1b47644e6d091c3f4a78f45 (diff) | |
| download | gitlab-ce-1c8fa70f9d0818e2a82089c8643a6e455bca47fd.tar.gz | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user/project/insights/index.md')
| -rw-r--r-- | doc/user/project/insights/index.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/user/project/insights/index.md b/doc/user/project/insights/index.md index 4af6f47ce7b..52fcad8dd80 100644 --- a/doc/user/project/insights/index.md +++ b/doc/user/project/insights/index.md @@ -61,6 +61,7 @@ bugsCharts: title: "Charts for bugs" charts: - title: "Monthly bugs created" + description: "Open bugs created per month" type: bar query: issuable_type: issue @@ -77,6 +78,7 @@ For example, here's single chart definition: ```yaml - title: "Monthly bugs created" + description: "Open bugs created per month" type: bar query: issuable_type: issue @@ -96,6 +98,7 @@ The following table lists available parameters for charts: | Keyword | Description | |:---------------------------------------------------|:------------| | [`title`](#title) | The title of the chart. This will displayed on the Insights page. | +| [`description`](#description) | A description for the individual chart. This will be displayed above the relevant chart. | | [`type`](#type) | The type of chart: `bar`, `line` or `stacked-bar`. | | [`query`](#query) | A hash that defines the conditions for issues / merge requests to be part of the chart. | @@ -114,6 +117,17 @@ monthlyBugsCreated: title: "Monthly bugs created" ``` +### `description` + +The `description` text is displayed above the chart, but below the title. It's used +to give extra details regarding the chart, for example: + +```yaml +monthlyBugsCreated: + title: "Monthly bugs created" + description: "Open bugs created per month" +``` + ### `type` `type` is the chart type. @@ -145,6 +159,7 @@ Example: ```yaml monthlyBugsCreated: title: "Monthly bugs created" + description: "Open bugs created per month" type: bar query: issuable_type: issue @@ -283,6 +298,7 @@ a group's insights: ```yaml monthlyBugsCreated: title: "Monthly bugs created" + description: "Open bugs created per month" type: bar query: issuable_type: issue @@ -311,6 +327,7 @@ bugsCharts: title: "Charts for bugs" charts: - title: "Monthly bugs created" + description: "Open bugs created per month" type: bar <<: *projectsOnly query: |