Create a wiki for your team project

VSTS | TFS 2018

Each team project can be provisioned with a wiki. Use it to share information with your team to understand, use, and contribute to your project.

Note

The built-in wiki is available with TFS 2018 and later versions. To download TFS 2018, see the TFS 2018 Release Notes. If you were using the Wiki Marketplace extension, you can migrate your existing pages to the new team project wiki.

Each team project wiki is powered by a Git repository in the back-end. When you create a team project, a Wiki Git repo is not created by default. To start using a wiki, you must either provision a Git repository to store your wiki markdown files, or publish existing markdown files from a Git repository to a wiki.

Each team project wiki is powered by a Git repository in the back-end. When you create a team project, a Wiki Git repo is not created by default. To start using a wiki, you must provision a Git repository to store your wiki markdown files.

Use this topic to learn how to:

  • Open the Wiki hub
  • Provision a Git repo for your wiki

Prerequisites

  • You must have a team project. If you don't have a team project yet, create one in VSTS.
  • You must be a member of the Project Administrators group in order to provision a wiki.
  • Anyone who is a member of the Contributors security group can add or edit wiki pages. Anyone with access to the team project, including stakeholders, can view the wiki.
  • You must have a team project. If you don't have a team project yet, create one in your on-premises TFS.
  • You must be a member of the Project Administrators group in order to provision a wiki or publish markdown files from an existing Git repo to a wiki.
  • Anyone who is a member of the Contributors security group can add or edit wiki pages. Anyone with access to the team project, including stakeholders, can view the wiki.

Open the Wiki hub

Begin by connecting to your team project using a supported web browser and choose the Wiki hub.

Open Wiki hub

  • If you need to switch your team project, click the VSTS icon to browse all team projects and teams.
  • If you don't see the Wiki hub, your screen size may be reduced. Click the three dots (elipses), then choose Wiki>Wiki.

Open wiki hub, reduced screen size

Provision a wiki Git repository

On the Wiki landing page, choose Create Wiki to provision a new Git repository that will store all your wiki pages and related artifacts. (Even if you use TFVC for source control, you can create a wiki with a Git repository.)

Create wiki, provision a Git repo for your wiki or publish existing repo markdown files

Create wiki, provision a Git repo for your wiki

If you don't have access to create a Wiki Git repository, you will see a page as follows.

Unable to create a Wiki repository

You can contact your administrator to provision the Wiki Git repository or request that they elevate your permissions. Stakeholders can't be granted permissions to create a wiki as they have no permissions to work in the Code hub.

The Wiki Git repo is referred as TeamProjectName.wiki. For example, if your team project is 'foobar' then the Wiki repo is labeled 'foobar.wiki'.

Try this next

Why is the Git repository hidden?

The TeamProjectName.wiki doesn't appear in the drop-down menu of repositories in the Code hub, nor in the list provided in the team project administration context, Version Control page.

However, you can navigate to it from the following URL:

https://<AccountName>.visualstudio.com/DefaultCollection/<TeamProjectName>/_git/<TeamProjectName>.wiki

https://<ServerName>/DefaultCollection/<TeamProjectName>/_git/<TeamProjectName>.wiki

You can click More followed by Clone Wiki to access the Wiki URL.

Clone wiki

This will expose the URL of the wiki Git repository and you can paste it into your web browser to access the underlying Git repo.