Jump to content

Phabricator/Help/Dashboards

From mediawiki.org

Phabricator Dashboards are home pages which can display a wide range of custom information. They can be created, managed and shared between users.

Teams could use them to direct team members to the right projects, display recently added tasks to the team's backlog, list tasks a user is assigned or is subscribed to.

To access the full list of dashboards, or make a new one, see phab:dashboard. In the main Dashboard list, you will find all dashboards as well as the "Create Dashboard" button.

Note: dashboards are shared with all users by default. Only the original creator can change access levels.

How to create a Dashboard

[edit]

Clicking on the "Create Dashboard" link will give you options for an empty Dashboard or a simple one. Empty Dashboards encourage you to play with panels and directly offer you more sharing options.

When making an empty Dashboard, you will be prompted to name it and select sharing options. Be mindful of your dashboard name choice. Searching for dashboards in the main list can be difficult if several are named similarly.

Set "Editable By" to your account and/or members of your team (if the widgets on the dashboard are supposed to be a shared responsibility). Due to spammers we do not recommend to set it to "All Users".

Adding and adjusting Panels

[edit]

There are 2 types of Panels: Queries and Text. There is also a special Panel called a Tab Panel, which calls on Query and Text Panels.

Text panels allow the user to add any text or formatting that is allowed in task text boxes.

Query panels require a few more settings. You also need to create a pre-saved search/query in Maniphest before creating a query panel. If your query produces a certain data type (like tasks), you MUST select that option in the "Search for" field. This is the only way your pre-saved searches in Maniphest will show up in the query field options.

Where Query Panels call on saved queries within the various Phabricator advance search modes, Tab Panels call on Panels themselves. The list of Panels can be found at phab:dashboard/panel/. When creating the Tab Panel it will have a search field for the panel you want to add to a tab, and call on the aforementioned list. To add to that list, you must create a Query or Text Panel in a Dashboard first, the same as creating a query for a Query Panel. If the panel does not autocomplete, refer to the panel list and make note of the "W#" number, which will make your panel easier to find. Then put that code into the Tab Panel search field.

Editing a Dashboard

[edit]

If you need to go back and edit a dashboard, you must select it from the main list. When it has loaded, click the "Manage Dashboard" link. This is the only way to get into the edit mode.

Example

[edit]

There is an example dashboard available at phab:dashboard/view/120/. It includes a text panel with team information and 3 query panels with varying amounts of information. You can copy this dashboard and deconstruct the panels to see how they are put together.

Below is an example text panel for the Wikimedia FR-tech team. It provides general information about who is on the team and which projects to look for. You could use this panel to direct teams to key wiki pages or other external locations as well. This is also an option for global information, reminders or other information that does not fit into single tasks.