Quickstart: Share your project vision, view project activity

Azure DevOps Services | Azure DevOps Server 2019 | TFS 2018 | TFS 2017 | TFS 2015

In this quickstart, you learn how to share your project with your team, add project members, and check the latest project activity. Share your project and objective, and ways for team members to contribute to the project through a project README file or through a project wiki.

If you want to use a project wiki, then first create a Wiki for your project. You can then change the project summary page to point to the wiki.

From the project home page, share your project with your team, add project members, and check the latest project activity. Share your project and objective, and ways for team members to contribute to the project through a project README file.

Note

The features and functions available from your project page depend on the source control, Git, or Team Foundation Version Control (TFVC) that you selected when you created your team project.

Prerequisites

  • You must be a member of the Project Administrators group or have your Edit project-level information permission set to Allow to do the following:
    • Edit information on the project page
    • Change the repository that you use to share your project mission
    • Manage project membership
  • To edit a page, you must be a contributor to the repository or branch or have the Contribute permissions set to Allow.
  • To view the project page, you must be a valid member of the project. For more information, see Permissions and groups, Valid user groups.

Open project summary

From your web browser, choose Overview > Summary. If you don't have a project yet, create a project.

If you haven't set up your project summary yet, you'll see this welcome page:

Open project summary, new nav

Select one of the following tasks to get started:

To support your project mission, choose a README file that you maintain in a project repository, or the project Wiki. To choose between a README file or a Wiki, see Change the repository. To define a README file for your project, see Initialize a README file for your Git repo or Initialize a README file for your TFVC repo.

From your web browser, open the team project drop down menu and select the home page. If you don't have a project, create a team project.

Open Project Summary

To define a README file for your project, see Initialize a README file for your Git repo or Initialize a README file for your TFVC repo.

Note

The project page described in this section is available for TFS 2017.1 and later versions. It replaces the Welcome page used in TFS 2015 and TFS 2017.

Initialize a README file for a Git repo

You can share your project and objective, as well as ways for team members to contribute to the project through a project README file. For Git projects, the README.md file needs to be at the root of each repository in the default branch. For Git based projects the left pane supports navigation to other repositories. A separate Welcome page/README.md file can be created for each repository.

  1. Open Repos>Files. This page guides you to get started quickly by adding code to your repository when you choose one of the options to clone, push, import, or initialize a repo.

  2. With the Add a README check box checked, choose Initialize.

    Initialize README file, new nav

    A default README file is added to the project repository, in this case, the Fabrikam Test repo.

  3. Return to Overview>Summary and choose the README file for the project page. Choose the  edit icon.

    Choose README file, new nav

  4. Select the project repository where you initialized the README file.

    Choose Repository where the README file exists, new nav

  5. To edit the README file, choose the README file link.

    Edit the README file, new nav

    You're directed to the Repos>Files page for the README file. You can edit and modify the README Markdown file like you would any other file in a Git repository. You can use Markdown language to format the README file and add images. To learn more about adding a README file, see Create a README for your repo and Markdown guidance.

  1. Open the Project home page.

  2. With the Add a README check box checked, choose Initialize.

    Initialize README file, new nav

    A default README file is added to the project repository, in this case, the Fabrikam Test repo.

  3. To edit the project README.md file, choose Edit.

    Git new project summary page

    Use Markdown language to format the README file and add images. To learn more about adding a README file, see Create a README for your repo and Markdown guidance.

  1. You can start editing directly from the Welcome page.

    Project page, Edit Welcome Markdown page

    Note

    If you set policies on the Git repository, changes to the welcome page must be done as a pull request.

  2. To add another page, enter a link to a new Markdown file that doesn't yet exist, for example:

    [page-1](./page-1.md)

  3. After you save the file, select the link. Respond to the prompt to edit the file and commit it to your repository.

Initialize a README file for a TFVC repo

For projects that selected TFVC for version control, the README.md file needs to be at the root of your team project folder (i.e. $/TeamProject/README.md).

  1. Open Repos>Files.

  2. Select Add Project Description.

    Welcome page, TFVC new project, create readme, new nav

  3. Select the TFVC repository and choose Save. If no README file has been created yet in the repo, you'll see the following message.

    About this project dialog, new nav

  4. To create a README file, choose Repos>Files and choose new file to add a file to the project repository.

  5. Name the file as README.md.

    Add new file dialog, new nav

  6. Add the contents of your README file in Markdown format, and then choose Check in....

    Enter README file contents, new nav

  7. Select Check in to complete the check in process of the README file.

    Check-in README file dialog, new nav

  8. Select Overview>Summary to review your project summary page with the README file displayed.

    About this project dialog, new nav

  1. Open the Project home page.

  2. Select Create README.

    Welcome page, TFVC new project, create README

    A default README file is added to the project repository, in this case, the Fabrikam Fiber TFVC repo.

  3. You can immediately edit the README file. When you're done, select Check in.

    Edit page, new nav
    Any additional Markdown files you have (ones with a *.md extension) in the root of the project folder also appear in the left pane for easy navigation between them so you can provide additional information.

View project activity, add project members

In addition to sharing information, the project summary page pulls data from the applications to give visitors a bird's-eye view of your project activity.

To add users to the project, choose the  add button. You can only add users to a project that you have already added to the organization. To learn more, see Add users to a team project or team.

Project stats

To add users to the project, choose the add button. To learn more, see Add users to a team project or team.

Project Home Page, Activity

Change the repository

You can change the repository used to support your project vision, including pointing it to the home page of your built-in Wiki.

  1. Open Overview > Summary .

  2. Choose the  edit icon.

    Choose README file, new nav

    If you don't see the Edit icon, then you're not a member of the Project Administrators group. Get added as an admin to proceed.

  3. Select a different repository or choose the Wiki option.

    Choose Repository where the README file exists, new nav

    Tip

    If you choose the Wiki option, only the Wiki home page displays. To access additional Wiki pages, you must navigate to the Wiki.

  1. From your project home page, choose Change.

    Project page, Change repo

    If you don't see Change link, then you're not a member of the Project Administrators group. Get added as an admin to proceed.

  2. From the select file dialog, choose an existing repo from the drop-down menu, or choose the Wiki option, shown as follows.

    Web portal, Project page, Select file to display dialog

    Tip

    Only the Wiki home page displays. To access additional Wiki pages, you must navigate to the Wiki.

Next steps