瀏覽代碼

Added docs for dashboard list panel, #2276

Torkel Ödegaard 10 年之前
父節點
當前提交
3c86c9908c
共有 4 個文件被更改,包括 22 次插入4 次删除
  1. 1 1
      docs/mkdocs.yml
  2. 18 0
      docs/sources/reference/dashlist.md
  3. 2 2
      public/app/panels/dashlist/editor.html
  4. 1 1
      public/app/panels/dashlist/module.js

+ 1 - 1
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']

+ 18 - 0
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
+
+
 

+ 2 - 2
public/app/panels/dashlist/editor.html

@@ -7,7 +7,7 @@
 					<strong>Mode</strong>
 				</li>
 				<li>
-					<select class="input-small tight-form-input" ng-model="panel.mode" ng-options="f for f in modes" ng-change="get_data()"></select>
+					<select class="input-small tight-form-input last" ng-model="panel.mode" ng-options="f for f in modes" ng-change="get_data()"></select>
 				</li>
 			</ul>
 			<div class="clearfix"></div>
@@ -47,7 +47,7 @@
 					<strong>Limit number to</strong>
 				</li>
 				<li>
-					<input class="input-small tight-form-input" type="number" ng-model="panel.limit" ng-model-onblur ng-change="get_data()">
+					<input class="input-small tight-form-input last" type="number" ng-model="panel.limit" ng-model-onblur ng-change="get_data()">
 				</li>
 			</ul>
 			<div class="clearfix"></div>

+ 1 - 1
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,
     });