Add Markdown to a dashboard

VSTS | TFS 2018 | TFS 2017 | TFS 2015.1-2015.3

Use the Markdown widget to support your team and stakeholders by adding information such as:

  • Team goals
  • Provide links to team backlogs or boards, metrics, or other items located in a network share such as a OneNote, SharePoint site or wiki pages
  • Important dates or target deadlines

Here's an example:

Web portal, Sample Markdown widget

Prerequisites

  • You must be a member of a team project. If you don't have a team project yet, create one in VSTS.
  • If you haven't been added as a team member, get added now.
  • Anyone with access to the team project, including stakeholders, can view dashboards.
  • To add, edit, or manage a team dashboard, you must be a team admin, a project admin, or have dashboard permissions. In general, you need to be a team admin for the currently selected team to edit dashboards. Request your current team or project admin to add you as a team admin.

Prerequisites

  • You must be a member of a team project. If you don't have a team project yet, create one in an on-premises TFS.
  • If you haven't been added as a team member, get added now.
  • Anyone with access to the team project, including stakeholders, can view dashboards.
  • To add a widget to a team dashboard, you must be a team admin, a project admin, or have dashboard permissions. In general, you need to be a team admin for the currently selected team to edit dashboards. Request your current team or project admin to add you as a team admin.

Prerequisites

Connect to the web portal for your team project

To add the markdown widget to a dashboard, you connect to your team project using a supported web browser. If you don't have a team project yet, create one in VSTS.

Open a browser window and click the Dashboards hub. If you haven't been added as a team member, get added now.

Open the Dashboards hub

If you don't see the team or team project you want, click the project icon project icon to browse all team projects and teams.

Add the markdown widget to a dashboard

If you need to add a dashboard, see Add and manage dashboards.

Note

Requires TFS 2015.1 or later version. �

To enable the New Dashboard experience, see Enable preview features.

To add the markdown widget to the dashboard, click Edit dashboard icon. The widget catalog will automatically open.

  1. Drag the Markdown widget onto the dashboard where you want it located.
    Markdown widget

  2. Click Done Editing to exit dashboard editing. This will dismiss the widget catalog. You can then configure the markdown widget as needed.

  3. Click the gear icon gear icon to open the configuration dialog for the widget.

    To edit a markdown widget, you may need to be a team admin, a member of the Project Administrators group, or be granted permissions. To learn more, see Set dashboard permissions.

  4. Adjust the widget size as needed to fit the contents of the markdown you'll enter. The largest size is 10 tiles wide by 10 tiles tall. You can always adjust this later.

    Change markdown widget size

  5. Enter the text and markdown syntax into the configuration the configuration dialog. For supported syntax, see Syntax guidance for Markdown files, widgets, wikis, and pull request comments.

    Here we show some simple text with a bulleted list of four links

    Configure markdown

    To link to a wiki page, repository file, hub, or page within the team project, use this format:

    /DefaultCollection/Fabrikam%20Fiber/Voice/_wiki?pagePath=%2FHome /DefaultCollection/Fabrikam%20Fiber/Voice/_git/Fabrikam%20Fiber?path=%2FREADME.md /DefaultCollection/Fabrikam%20Fiber/Voice/_backlogs?level=Backlog%20items&showParents=false&_a=backlog

    This renders the following widget:

    Web portal, Sample Markdown widget

    Note

    Links to documents on file shares using file:// are not supported on VSTS or TFS 2017.1 and later versions. This restriction has been implemented for security purposes.

  6. Optionally, you can choose to point to a file in your repository.

    Configure Markdown widget with a repo file

The New Dashboard experience is only available from VSTS at this time.