Share your project vision, view project activity

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

From the project summary page, you can share your project vision with your team, add project members, and check the latest project activity. You can share your project vision and objective, as well as 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 you'll want to 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, you can share your project vision with your team, add project members, and check the latest project activity. You can share your project vision and objective, as well as 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

  • To edit information on the project page, change the repository used to share your project vision. or manage project membership, you must be a member of the Project Administrators group or have your Edit project-level information permission set to Allow.
  • 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

Note

Choose Previous navigation when you see a top-level blue bar. Choose New navigation if you see a vertical sidebar or if you enabled the New Navigation preview feature. The vertical sidebar, along with other navigational features, is enabled when the New Navigation preview feature has been enabled for the signed-in user or the organization. To learn how to use the web portal effectively, see Web portal navigation.

For on-premises TFS, choose Previous Navigation for guidance.

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

You can select one of the following tasks to get started:

To support your project vision, you can 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.

New navigation isn't supported on TFS at this time. Choose Previous navigation for guidance.

Initialize a README file for a Git repo

You can share your project vision 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 simply 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'll be 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.

New navigation isn't supported on TFS at this time. Choose Previous navigation for guidance.

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. Choose Add Project Description.

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

  3. You can 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. Choose Check in to complete the check in process of the README file.

    Check-in README file dialog, new nav

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

    About this project dialog, new nav

New navigation isn't supported on TFS at this time. Choose Previous navigation for guidance.

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 in order 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.

New navigation isn't supported on TFS at this time. Choose Previous navigation for guidance.

Try this next