| Edwin Kempin | d25d10a | 2012-07-19 10:56:34 +0200 | [diff] [blame^] | 1 | Gerrit Code Review - Custom Dashboards |
| 2 | ====================================== |
| 3 | |
| 4 | Description |
| 5 | ----------- |
| 6 | |
| 7 | A custom dashboard is shown in a layout similar to the per-user |
| 8 | dashboard, but the sections are entirely configured from the URL. |
| 9 | Because of this custom dashboards are stateless on the server side. |
| 10 | Users or projects can simply trade URLs using an external system like |
| 11 | a project wiki, or site administrators can put the links into the |
| 12 | site's `GerritHeader.html` or `GerritFooter.html`. |
| 13 | |
| 14 | Dashboards are available via URLs like: |
| 15 | ---- |
| 16 | /#/dashboard/?title=Custom+View&To+Review=reviewer:john.doe@example.com&Pending+In+myproject=project:myproject+is:open |
| 17 | ---- |
| 18 | This opens a view showing the title "Custom View" with two sections, |
| 19 | "To Review" and "Pending in myproject": |
| 20 | ---- |
| 21 | Custom View |
| 22 | |
| 23 | To Review |
| 24 | |
| 25 | Results of `reviewer:john.doe@example.com` |
| 26 | |
| 27 | Pending In myproject |
| 28 | |
| 29 | Results of `project:myproject is:open` |
| 30 | ---- |
| 31 | |
| 32 | The dashboard URLs are easy to configure. All keys and values in the |
| 33 | URL are encoded as query parameters. Set the page and window title |
| 34 | using an optional `title=Text` parameter. |
| 35 | |
| 36 | Each section's title is defined by the parameter name, the section |
| 37 | display order is defined by the order the parameters appear in the |
| 38 | URL, and the query results are defined by the parameter value. To |
| 39 | limit the number of rows in a query use `limit:N`, otherwise the |
| 40 | entire result set will be shown (up to the user's query limit). |
| 41 | |
| 42 | Parameters may be separated from each other using any of the following |
| 43 | characters, as some users may find one more readable than another: |
| 44 | `&` or `;` or `,` |
| 45 | |
| 46 | GERRIT |
| 47 | ------ |
| 48 | Part of link:index.html[Gerrit Code Review] |
