View and update project summary page

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

Each project provides a summary or home page to share information and showcase the latest project activity. This page serves as a central hub for team members to stay informed and up-to-date on the project's progress. Use this page for the following tasks:

• Share important project updates and announcements
• Highlight recent activities and milestones
• Provide quick access to key project resources and documentation
• Facilitate team collaboration and communication

Use the project summary page to also perform more specific 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

• 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

You can designate hosted projects 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. For more information, see What is a public project?

Prerequisites

• Permissions: Be a member of the Project Administrators group or have your Edit project-level information permission set to Allow to do the following tasks:
  • Edit information on the project page
  • Change the repository that you use to share project information
  • Manage project membership
• Specific tasks:
  • To edit a project page, be a contributor to the repository or branch or have the Contribute permissions set to Allow.
  • To view the project summary, 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, have the project-level Manage properties permission set to Allow. This permission controls the project properties REST API.

Tip

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

Open project summary

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

If your project summary isn't set up yet, a welcome page displays:

Select one of the following tasks to get started:

• Invite to begin adding others to your project. You can only invite users who are added to your organization.
• Boards to begin adding work items.
• Repos to open Repos>Files page where you can clone or import a repository, or initialize a README file for your project summary page.
• Pipelines to start defining a pipeline.
• Test Plans to start defining test plans and test suites.
• Manage your services to disable the visibility of one or more services.

Update the summary page

The summary page displays either the README file defined in a project repository or the home page of a project wiki. To use the project wiki home page, create a wiki for your project and then you can change the project summary page to point to the wiki.

1. Edit the page:

   • If it's your first time editing the page, select Add Project Description.
     

   • If it's not your first time editing the page, select 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.

   

3. (Optional) 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 you choose a Readme file, select the repository for the README. A preview of the current text for the README file is shown.

   

   If you choose a Wiki, 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 contributors to your project

Send an email to invite users to contribute to your project by choosing Invite. For more information, see Add users or groups to a team or project, Invite users from the Summary page.

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.

Chat with a project member or send an email

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

Note

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

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

Search a project

From the Summary page, you can initiate a search of your code, work items, and wiki. For more information, see Get started with search.

Initialize a README file for a Git repo

You can share your project and objective, and 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.

   

   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.

   

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

   

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

   

   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. For more information, 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, for example, $/TeamProject/README.md.

1. Open Repos > Files.

2. Select Add Project Description.

   

3. Select the TFVC repository and choose Save. If no README file is in the repo, you see the following message.

   

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.

   

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

   

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

   

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

   

Related articles

• Learn about Wikis, READMEs, and Markdown
• Get started as an administrator
• Navigate the web portal
• Discover what you get with a project

REST APIs

• Get project properties
• Set project properties