Share your project vision, view project activity

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019 | TFS 2018

Each project provides a Summary or home page to share information and showcase the latest project activity. Use this page to perform one or more of the following tasks.

Project Administrator tasks

Project member tasks

  • Add a short project description
  • Choose a README file or wiki for project information
  • Invite people to contribute to your project
  • Set project tags
  • Choose a README file or wiki for project information
  • Invite people to contribute to your project
  • View project information
  • View project activity
  • Favorite a project
  • Email or initiate a chat with a team member
  • Initiate a search across your project
  • View project information
  • Email or initiate a chat with a team member
  • View project activity

Note

Hosted projects can be designated as Private or Public. For public projects, anonymous users can view the project Summary, except for the Members section. Also the Like and Favorite icons aren't visible to anonymous users. To learn more about public projects, see What is a public project?

Screenshot of summary page.

Screenshot of summary page, TFS-2018.

Note

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

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 project information
    • 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 Summary, you must be a valid member of the project. For more information, see About security, membership, and permissions; Valid user groups.
  • To add or edit project Tags, you must have the project-level Manage properties permission set to Allow. This permission controls the project properties REST API. The project properties REST API is used to drive the project tags experience in the product.

Tip

If you don't have permissions to edit a page or use a feature, the corresponding icons and links aren't visible.

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:

Open project Home page

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.

Update the page

The Summary page displays either the README file defined in a project repository or the home page of a project wiki. If you want to use the project wiki home page, first set that up as described in Create a Wiki for your project.

  1. To edit the page:

    • If it is the first time editing the page, choose Add Project Description.
      Screenshot of summary page, first time editing.

    • If editing the page after it's been set up, choose the Edit project information. This icon is only visible to members with permissions to edit the project Summary page.

  2. Provide a brief description of the project purpose in the Description box.

    About this project dialog.

  3. Optionally add one or more Tags for your project. These tags are similar to work item tags. You can add several tags at a time by using the comma or semicolon delimiters. Tags must conform to the following rules:

    • Tags must be 40 characters or less
    • Tags can;t contain the forward slash (/) character or end with hyphen character (-)
    • No more than 15 tags can be added to a project
    • Tags are case-insensitive and no duplicate tags or empty tags are allowed.

    Note

    The search and filter functions can't be used to search or filter on project tags.

  4. Choose whether to reference a README file or the project wiki home page for the rest of the Summary page contents.

    Tip

    A default README is created within the repository added when you created your project. You can choose this README or create another repository and README file for this purpose.

    If choosing a Readme file, select the repository for the README. A preview of the current text for the README file is shown.

    About this project dialog, choose and select README repository.

    If choosing Wiki, note that the Wiki home page is referenced and must be the first file within the Wiki TOC. You can't change that reference.

  5. To update the contents of the referenced README file or wiki, edit the corresponding file. For more information, see Create a README for your repo or Add and edit wiki pages.

    Consider including the following types of information in your Summary page:

    • Ways in which users can contribute to your project
    • Who to contact to elevate permissions or add extensions
    • Roadmap information
    • Links to instructions for setting up their development and test environments
    • Links to instructions for collaborating on code, tracking work, building pipelines, deploying releases
    • Links to templates to file a bug, issue, or request
    • Links to distribution lists to email a question or post a question on Slack or Teams channel.

Invite people to contribute to your project

You can send an email to invite users to contribute to your project by choosing Invite. To learn more, see Add users or groups to a team or project, Invite users from the Summary page.

Screenshot of Summary page, Invite button.

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

Screenshot of Summary page, Add members button.

Note

For on-premises Azure DevOps, all email actions require an SMTP server to be configured.

View project activity

From the Project stats or Activity section, you can view updates made to the project in the last 1, 7, or 30 days. Choose the view option as shown in the following image.

Screenshot of Summary page, Stats section.

Screenshot of Summary page, Activity section, TFS-2018.

Email or chat with a project member

From the Members section, you can see some of the members that have been added to the project, and connect to them via email or chat with a member.

Screenshot of Summary page, Members section.

Note

100+ indicates that 100 or more members have been added to the project.

To email or initiate a chat session, choose the team member shown and select your option.

Screenshot of Summary page, Members section, options available to connect to a team member.

Note

For on-premises Azure DevOps, all email actions require an SMTP server to be configured.

From the Summary page, you can initiate a search of your code, work items, and wiki. To learn more, see Get started with search. Screenshot of Summary page, search box.

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.

    Screenshot of Initialize README file, latest versions

    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. Select Edit.

    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.

    Screenshot of 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.

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.

    Project summary page with the README file displayed.

  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.

REST APIs