Commit 33899d27 authored by Amy Qualls's avatar Amy Qualls

Merge branch '219507-add-links-documentation' into 'master'

Add documentation for metrics dashboard links key

Closes #219507

See merge request gitlab-org/gitlab!33430
parents 2977a70c 777ce6e4
......@@ -378,16 +378,26 @@ The following tables outline the details of expected properties.
| ------ | ------ | ------ | ------ |
| `dashboard` | string | yes | Heading for the dashboard. Only one dashboard should be defined per file. |
| `panel_groups` | array | yes | The panel groups which should be on the dashboard. |
| `templating` | Hash | no | Top level key under which templating related options can be added. |
| `templating` | hash | no | Top level key under which templating related options can be added. |
| `links` | array | no | Add links to display on the dashboard. |
##### **Templating (`templating`) properties**
| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |
| `variables` | Hash | no | Variables can be defined here. |
| `variables` | hash | no | Variables can be defined here. |
Read the documentation on [templating](#templating-variables-for-metrics-dashboards).
##### **Links (`links`) properties**
| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |
| `url` | string | yes | The address of the link. |
| `title` | string | no | Display title for the link. |
Read the documentation on [links](#add-related-links-to-custom-dashboards).
##### **Panel group (`panel_groups`) properties**
| Property | Type | Required | Description |
......@@ -825,6 +835,28 @@ templating:
default: true # (Optional) This option should be the default value of this variable.
```
### Add related links to custom dashboards
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/216385) in GitLab 13.1.
Related links can be added to the top of your metrics dashboard, which can be used for quickly
navigating between dashboards or external services. The links will open in the same tab.
The `url` attribute is required for the link but the `title` attribute is optional; if the `title`
is missing then the full address of the URL will be displayed.
![Links UI](img/related_links_v13_1.png)
#### Links Syntax
```yaml
links:
- title: GitLab.com
url: https://gitlab.com
- title: GitLab Documentation
url: https://docs.gitlab.com
```
### View and edit the source file of a custom dashboard
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/34779) in GitLab 12.5.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment