diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 7d84dba5f0d..13eaf757c94 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -45,7 +45,7 @@ pages: - ['reference/graph.md', 'Reference', 'Graph Panel'] - ['reference/singlestat.md', 'Reference', 'Singlestat Panel'] -- ['reference/dashlist.md', 'Reference', 'Dashlist Panel'] +- ['reference/dashlist.md', 'Reference', 'Dashboard list Panel'] - ['reference/sharing.md', 'Reference', 'Sharing'] - ['reference/annotations.md', 'Reference', 'Annotations'] - ['reference/timerange.md', 'Reference', 'Time range controls'] diff --git a/docs/sources/reference/dashlist.md b/docs/sources/reference/dashlist.md index 6f591169f2c..9a54a18e288 100644 --- a/docs/sources/reference/dashlist.md +++ b/docs/sources/reference/dashlist.md @@ -6,4 +6,22 @@ page_keywords: grafana, dashlist, panel, documentation # Dashlist Panel +## Overview +![](/img/v2/dashboard_list_panel.png) + +The dashboard list panel allows you to show a list of links to other dashboards. The list +can be based on a search query or dashboard tag query. You can also configure it to show your starred +dashboards. + +## Options +![](/img/v2/dashboard_list_panel_options.png) + +Name | Description +------------ | ------------- +Mode | Set search or starred mode +Query | If in search mode specify the search query +Tags | if in search mode specify dashboard tags to search for +Limit number to | Specify the maximum number of dashboards + + diff --git a/public/app/panels/dashlist/editor.html b/public/app/panels/dashlist/editor.html index ff2e75fd95c..7b176b74317 100644 --- a/public/app/panels/dashlist/editor.html +++ b/public/app/panels/dashlist/editor.html @@ -7,7 +7,7 @@ Mode
  • - +
  • @@ -47,7 +47,7 @@ Limit number to
  • - +
  • diff --git a/public/app/panels/dashlist/module.js b/public/app/panels/dashlist/module.js index 647199d6538..3e7c8c5587c 100644 --- a/public/app/panels/dashlist/module.js +++ b/public/app/panels/dashlist/module.js @@ -21,7 +21,7 @@ function (angular, app, _, config, PanelMeta) { module.controller('DashListPanelCtrl', function($scope, panelSrv, backendSrv) { $scope.panelMeta = new PanelMeta({ - panelName: 'Dash list', + panelName: 'Dashboard list', editIcon: "fa fa-star", fullscreen: true, });