opendev/gerrit
Code Issues Proposed changes

Fix description of dashboard config file

Browse Source 
The 'main' section was renamed to 'dashboard' but the documentation
was not updated. Also describe the new 'title' parameter.

Change-Id: Iade9095adf1967487369b1567f28ed4f5a25a0a7
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
This commit is contained in:
Edwin Kempin
2012-11-20 16:42:06 +01:00
parent d85df6496d
commit f6db7ff491
1 changed files with 11 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
Documentation/user-dashboards.txt
View File

@@ -55,7 +55,7 @@ the dashboard.
Example dashboard config file `MyProject Dashboard`:
----
[main]
[dashboard]
description = Most recent open and merged changes.
[section "Open Changes"]
query = status:open project:myProject limit:15
@@ -83,10 +83,17 @@ dashboard to be restricted to only changes for the project in which
an inherited dashboard is being applied by simply adding
`project:${project}` to the queries in the dashboard.
Section main
~~~~~~~~~~~~
Section dashboard
~~~~~~~~~~~~~~~~~
main.description::
dashboard.title::
+
The title of the dashboard.
+
If not specified the path of the dashboard config file is used as
title.
dashboard.description::
+
The description of the dashboard.