Commit cf79b6b6 authored by Kirstie Cook's avatar Kirstie Cook

Add documentation for links key

parent cd288b57
...@@ -378,16 +378,24 @@ The following tables outline the details of expected properties. ...@@ -378,16 +378,24 @@ The following tables outline the details of expected properties.
| ------ | ------ | ------ | ------ | | ------ | ------ | ------ | ------ |
| `dashboard` | string | yes | Heading for the dashboard. Only one dashboard should be defined per file. | | `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. | | `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** ##### **Templating (`templating`) properties**
| Property | Type | Required | Description | | 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). 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. |
##### **Panel group (`panel_groups`) properties** ##### **Panel group (`panel_groups`) properties**
| Property | Type | Required | Description | | Property | Type | Required | Description |
......
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