Skip to content

Commit d93ddd3

Browse files
authored
Merge pull request #7590 from MicrosoftDocs/users/chcomley/prereq-tables-366514-p-1
Part 1 of 4 - Standardized prerequisites
2 parents d0c0312 + 7132ccc commit d93ddd3

32 files changed

+228
-413
lines changed

docs/extend/develop/add-action.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ In this example, we add an action to the query context menu in the work item que
1919

2020
[!INCLUDE [extension-docs-new-sdk](../../includes/extension-docs-new-sdk.md)]
2121

22-
## Prerequisites for this article
22+
## Prerequisites
2323

24-
- You need to create a web app for your action, which can be found in the [hub example](./add-hub.md).
25-
- If you haven't, take a look at the [write your first extension tutorial](../get-started/node.md) to learn about the basics.
24+
- [Develop a web extension](../get-started/node.md).
25+
- [Create a web app for your action](./add-hub.md).
2626

2727
## Update extension manifest file
2828

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
ms.topic: include
3+
ms.date: 01/27/2025
4+
---
5+
6+
**Permissions:** At least [**Contributor** role](../organizations/security/permissions.md).

docs/integrate/get-started/auth/tfs-basic-auth.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@ ms.date: 11/10/2023
1717
Use personal access tokens (PATs) with the cross-platform CLI for Azure DevOps.
1818

1919
> [!IMPORTANT]
20-
> We don't recommend using basic authentication. For Azure DevOps Services, see [Sign in with a PAT](../../../cli/log-in-via-pat.md).
20+
> We don't recommend using basic authentication or PATs. Instead, we recommend using [Microsoft Entra-based authentication](../authentication/entra.md), if you're interacting with Microsoft Entra accounts.
2121
2222
## Prerequisites
2323

24-
- Download the latest version of **Node.js source code**, from the [Node.js source code downloads page](https://nodejs.org/en/download/)
25-
- Install the **Cross-platform CLI for Azure DevOps**
24+
- Latest version of [**Node.js source code**](https://nodejs.org/en/download/)
25+
- **Cross-platform CLI for Azure DevOps**
2626
- Install **tfx-cli** using `npm`, a component of Node.js by running:
2727

2828
```no-highlight

docs/marketplace/grant-permissions.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,13 @@ Learn how to manage permissions for users or groups, so they can manage extensio
1919

2020
## Prerequisites
2121
::: moniker range="azure-devops"
22-
- Be a member of the Project Collection Administrators group to manage permissions for users or groups. Organization owners are automatically members of this group.
23-
- Private extensions must be shared with your organization to be installed. Check out the [publishing documentation](../extend/publish/overview.md) for information on how to share private extensions.
22+
- **Permissions:** Member of the Project Collection Administrators group. Organization owners are automatically members of this group.
23+
- **Extension sharing:** Private extensions [shared with your organization](../extend/publish/overview.md#share-your-extension).
2424
::: moniker-end
2525

2626
::: moniker range="< azure-devops"
27-
- Be a member of the Project Collection Administrators group or have "Edit collection-level information" permissions to manage permissions for users or groups. Organization owners are automatically members of the Project Collection Administrators group.
27+
- **Permissions:** Member of the Project Collection Administrators group or **Edit collection-level information** permissions. Organization owners are automatically members of this group.
28+
- **Extension sharing:** Private extensions [shared with your organization](../extend/publish/overview.md#share-your-extension).
2829
::: moniker-end
2930

3031
## Manage permissions

docs/marketplace/install-extension.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,18 @@ For more information about extensions, see the [developing](../extend/overview.m
2424

2525
::: moniker range="azure-devops"
2626

27-
- **Permissions:** Be a member of the Project Collection Administrators group to install extensions. Organization owners are automatically members of this group. If you don't have permissions, you can [request extensions](./request-extensions.md) instead or [look up a project collection administrator](../organizations/security/look-up-project-collection-administrators.md).
28-
- **Extension sharing:** Private extensions must be shared with your organization to be installed. For more information about sharing private extensions, see the [publishing documentation](../extend/publish/overview.md).
27+
- **Permissions:** Member of the Project Collection Administrators group. Organization owners are automatically members of this group. If you don't have permissions, you can [request extensions](./request-extensions.md) instead or [look up a project collection administrator](../organizations/security/look-up-project-collection-administrators.md).
28+
- **Extension sharing:** Private extensions [shared with your organization](../extend/publish/overview.md#share-your-extension).
2929

3030
::: moniker-end
3131

3232
::: moniker range="< azure-devops"
3333

34-
- **Permissions:** Be a member of the Project Collection Administrators group or have "Edit collection-level information" permissions. Organization owners are automatically members of this group. If you don't have permissions, you can [request extensions](./request-extensions.md) instead or [look up a project collection administrator](../organizations/security/look-up-project-collection-administrators.md).
35-
- **Extension sharing:** Private extensions must be shared with your organization to be installed. For more information about sharing private extensions, see the [publishing documentation](../extend/publish/overview.md).
34+
- **Permissions:** Member of the Project Collection Administrators group or **Edit collection-level information** permissions. Organization owners are automatically members of this group. If you don't have permissions, you can [request extensions](./request-extensions.md) instead or [look up a project collection administrator](../organizations/security/look-up-project-collection-administrators.md).
35+
- **Extension sharing:** Private extensions [shared with your organization](../extend/publish/overview.md#share-your-extension).
3636

3737
> [!NOTE]
38-
> To use an existing Azure subscription for billing, you need at least co-administrator permissions for that subscription. If you don't have permissions, an Azure Account Administrator or Service Administrator can [add you as co-administrator](/azure/billing-add-change-azure-subscription-administrator) to the Azure subscription in the Azure portal.
38+
> To use an existing Azure subscription for billing, have at least co-administrator permissions for that subscription. If you don't have permissions, an Azure Account Administrator or Service Administrator can [add you as co-administrator](/azure/billing-add-change-azure-subscription-administrator) to the Azure subscription in the Azure portal.
3939
4040
Your project collection reuses your Azure subscription for future Marketplace purchases. [Where can I find more info about Azure billing?](faq-extensions.yml)
4141

docs/marketplace/request-extensions.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,9 @@ Project Collection Administrators receive an email when another project member r
2020

2121
## Prerequisites
2222

23-
- To request extensions, be a contributor for your organization.
24-
- To approve extensions, be a member of the Project Collection Administrators group and have [**Edit collection-level information** permissions](../organizations/security/permissions.md#collection).
23+
**Permissions:**
24+
- To request extensions: Contributor for your organization.
25+
- To approve extensions: Member of the Project Collection Administrators group and [**Edit collection-level information** permissions](../organizations/security/permissions.md#collection).
2526

2627
## Request an extension
2728

docs/project/navigation/add-artifact-team.md

+8-38
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,21 @@ Select the service of interest to get started adding new artifacts or objects. F
1919

2020
Prior to adding an artifact, make sure that you've [selected the project and repository](go-to-project-repo.md) that you want to work in.
2121

22+
## Prerequisites
23+
24+
[!INCLUDE [prerequisites](../../boards/includes/prerequisites.md)]
25+
26+
There might be other prerequisites for managing specific items. For more information, see [Security groups, service accounts, and permissions reference](../../organizations/security/permissions.md).
27+
2228
## Add work items, queries, or other work tracking artifacts
2329

2430
You can quickly add a query or work item when working from a **Boards** or **Work** page.
2531

26-
::: moniker range=">= azure-devops-2019"
27-
2832
Choose a **Boards** page&mdash;such as **Work Items**, **Boards**, or **Backlogs**. Then choose the :::image type="icon" source="../../media/icons/blue-add.png" border="false"::: plus icon and select from the menu of options.
2933

3034
> [!div class="mx-imgBorder"]
3135
> ![Work, add artifact](media/add-artifact/add-work-item-query-vert.png)
3236
33-
::: moniker-end
34-
35-
36-
3737
To add other work tracking artifacts, see one of the following articles:
3838

3939
- To add a board, backlog, or sprint backlog, first [add a team](../../organizations/settings/add-teams.md) which will be associated with those artifacts
@@ -46,49 +46,33 @@ To add other work tracking artifacts, see one of the following articles:
4646

4747
You can quickly add a pull request, Git repository, or work item using the **Add** menu when working from **Code**.
4848

49-
::: moniker range=">= azure-devops-2019"
50-
5149
Expand the **Repos** service and choose **Files**, **Commits**, or **Pull Requests** (Git repos) or **Files**, **Changesets**, or **Shelvesets** (TFVC). Then, choose the :::image type="icon" source="../../media/icons/blue-add.png" border="false"::: plus icon and select from the menu of options.
5250

5351
> [!div class="mx-imgBorder"]
5452
> ![Add artifact](media/add-artifact/add-repo-vert.png)
5553
5654
For details on adding a Git repository, see [Git repository](../../repos/git/creatingrepo.md).
5755

58-
::: moniker-end
59-
60-
61-
62-
6356
Note that you can only add one TFVC repository per project, but an unlimited number of Git repositories. To learn more about Git artifacts, see one of the following articles:
6457

6558
- [Git repository](../../repos/git/creatingrepo.md)
6659
- [Git branch](../../repos/git/create-branch.md)
6760
- [Git pull request](../../repos/git/pull-requests.md)
6861
- [Add work items](../../boards/work-items/view-add-work-items.md)
6962

70-
71-
7263
## Add build and release pipelines
7364

74-
::: moniker range=">= azure-devops-2019"
75-
7665
Expand **Pipelines** and choose **Builds** or **Releases**. Then choose the :::image type="icon" source="../../media/icons/blue-add.png" border="false"::: plus icon and select from the menu of options.
7766

7867
> [!div class="mx-imgBorder"]
7968
> ![Add build and release pipelines.](media/add-artifact/add-pipeline-vert.png)
8069
81-
::: moniker-end
82-
83-
84-
85-
To learn more about adding other pipeline related artifacts, see the following articles:
70+
For more information about adding other pipeline related artifacts, see the following articles:
8671
- [Deployment groups](../../pipelines/release/deployment-groups/index.md)
8772
- [Task groups](../../pipelines/library/task-groups.md)
8873
- [Variable groups](../../pipelines/library/variable-groups.md)
8974
- [Secure files](../../pipelines/library/secure-files.md)
9075

91-
9276
## Add a team
9377

9478
Agile tools and dashboards are typically associated with teams. You add teams to a project. To learn more about teams, see [About teams and Agile tools](../../organizations/settings/about-teams-and-settings.md). To add a team, see [Add a team and team members](../../organizations/settings/add-teams.md).
@@ -97,17 +81,11 @@ Agile tools and dashboards are typically associated with teams. You add teams to
9781

9882
## View teams already defined
9983

100-
::: moniker range=">= azure-devops-2019"
101-
10284
To view the set of defined teams, open **Project settings**, and choose **Overview**.
10385

10486
> [!div class="mx-imgBorder"]
10587
> ![Web portal, Project Settings, Teams](media/add-artifact/view-teams-vert-brn.png)
10688
107-
::: moniker-end
108-
109-
110-
11189
## Add a dashboard
11290

11391
::: moniker range=">= azure-devops-2020"
@@ -118,23 +96,15 @@ Dashboards are associated with a team or a project. Each team can create and con
11896
Dashboards are associated with a team. Each team can create and configure a number of dashboards. To learn how, see [Add a dashboard](../../report/dashboards/dashboards.md).
11997
::: moniker-end
12098

121-
12299
## Add a wiki
123100

124101
If you don't have a wiki yet, you can add one. Once added, you can add and update pages to that wiki.
125102

126-
127-
::: moniker range=">= azure-devops-2019"
128-
129103
- [Create a wiki](../wiki/wiki-create-repo.md)
130104
- [Add and edit wiki pages](../wiki/add-edit-wiki.md)
131105
- [Publish a Git repository to a wiki](../wiki/publish-repo-to-wiki.md)
132106

133-
::: moniker-end
134-
135-
136-
137107
## Related articles
138108

139109
- [Azure Artifacts](../../artifacts/index.yml)
140-
- [Exploratory & Manual Testing](../../test/index.yml)
110+
- [Exploratory & Manual Testing](../../test/index.yml)

docs/project/navigation/filter-basics.md

+17-19
Original file line numberDiff line numberDiff line change
@@ -17,49 +17,47 @@ ms.date: 04/04/2022
1717

1818
[!INCLUDE [version-lt-eq-azure-devops](../../includes/version-lt-eq-azure-devops.md)]
1919

20-
Several applications and pages support filtering, which is very useful when a large number of artifacts or items have been defined. Most directory views provide one or more filter functions.
21-
22-
You can filter most items using keywords or a user name for an author of an item or where work is assigned to them. You can filter lists and boards in the following areas:
23-
24-
25-
::: moniker range=">= azure-devops-2019"
26-
- Git repositories: Branches, Commits, Commit history, Pull Requests, Pushes, and Repositories
27-
- Work tracking: Work Items, Boards, Backlogs, Sprint Backlogs, and Taskboards
28-
- Directories: Dashboards, Boards, Backlogs, Sprints, Queries, Builds, Releases
29-
30-
::: moniker-end
31-
20+
Several applications and pages in Azure DevOps support filtering, which is particularly useful when dealing with a large number of artifacts or items. Most directory views offer one or more filter functions to help you quickly find what you're looking for.
3221

22+
You can filter most items using keywords or a user name, either for the author of an item or where work is assigned to them. Filtering can be applied to lists and boards in the following areas:
3323

24+
- **Git repositories:** Branches, Commits, Commit history, Pull Requests, Pushes, and Repositories
25+
- **Work tracking:** Work Items, Boards, Backlogs, Sprint Backlogs, and Taskboards
26+
- **Directories:** Dashboards, Boards, Backlogs, Sprints, Queries, Builds, Releases
3427

3528
> [!NOTE]
36-
> You may have fewer or additional filter options based on the [features you've enabled](preview-features.md) or the platform and version that you are working from.
29+
> You might have fewer or other filter options based on the [enabled features](preview-features.md) or the platform and version that you're working from.
3730
31+
## Prerequisites
3832

39-
<a id="filter"></a>
33+
- **Access**:
34+
- Member of the project where you want to apply filters. If you don't have access, request it from your project administrator.
35+
- At least **Basic** access to use filtering features. Users with Stakeholder access may have limited filtering capabilities.
36+
- **Permissions**: Necessary permissions to view and interact with the items that you want to filter. This typically includes being a member of the Contributors group or having similar permissions.
4037

38+
<a id="filter"></a>
4139

4240
## Filter based on keywords, tags, or fields
4341

44-
To turn filtering on, choose the :::image type="icon" source="../../media/icons/filter-icon.png" border="false"::: filter icon.
42+
To turn on filtering, choose the :::image type="icon" source="../../media/icons/filter-icon.png" border="false"::: filter icon.
4543

46-
You can filter work items by typing a keyword or using one or more of the fields provided, such as work item type, assigned to, state, and tags. Based on the keyword that you enter, the filter function will list work items based on any visible/displayed column or field, including tags. Also, you can enter a value for an ID, whether or not the ID field is visible.
44+
You can filter work items by entering a keyword or using one or more of the fields provided, such as work item type, assigned to, state, and tags. Based on the keyword that you enter, the filter function lists work items based on any visible/displayed column or field, including tags. Also, you can enter a value for an ID, whether or not the ID field is visible.
4745

4846
![Backlogs, turn filtering on](../../boards/backlogs/media/filter-backlogs-options.png)
4947

50-
The filtered set is always a flat list, even if you've selected to show parents.
48+
The filtered set is always a flat list, even if you selected to show parents.
5149

5250
### Characters ignored by keyword filter criteria
5351

54-
The filter criteria ignores the following characters: `,` (comma), `.` (period), `/` (forward slash), and `\` (back slash).
52+
The filter criteria ignore the following characters: `,` (comma), `.` (period), `/` (forward slash), and `\` (back slash).
5553

5654
::: moniker range=">= azure-devops-2019"
5755

5856
## Filter directories
5957

6058
Choose the :::image type="icon" source="../../media/icons/filter-icon.png" border="false"::: filter icon to filter a directory list by keyword, team, or other supported field. Keywords apply to titles, descriptions, and team names.
6159

62-
For example, here we turn filtering on for the dashboard directory.
60+
For example, here we turn on filtering for the dashboard directory.
6361

6462
> [!div class="mx-imgBorder"]
6563
> ![Filter the dashboard directory](../../report/dashboards/media/dashboards/filter-directory.png)

docs/project/navigation/go-to-project-repo.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,13 @@ ms.date: 04/04/2022
1515

1616
[!INCLUDE [version-lt-eq-azure-devops](../../includes/version-lt-eq-azure-devops.md)]
1717

18-
1918
Several features depend on the project, repository, or team that you have selected. For example, dashboards, backlogs, and board views will change depending on the project and team you select.
2019

2120
Also, when you add a work item, the system references the default area and iteration paths defined for the team context. Work items you add from the team dashboard (new work item widget) and queries page are assigned the team default iteration. Work items you add from a team backlog or board, are assigned the team default backlog iteration. For more information, see [About teams and Agile tools](../../organizations/settings/about-teams-and-settings.md).
2221

2322
## Prerequisites
2423

25-
* Be added to a project as a member of the **Contributors** or administrator security group. To get added, [Add users to a project or team](../../organizations/security/add-users-team-project.md).
24+
[!INCLUDE [prerequisites-contributor-only](../../includes/prerequisites-contributor-only.md)]
2625

2726
::: moniker range="azure-devops"
2827

0 commit comments

Comments
 (0)