Skip to content

Commit 94b9c24

Browse files
Merge pull request #7986 from GitHubber17/wiki-421753-d
Freshness: Azure DevOps - Wiki
2 parents d54f03c + ddf28ba commit 94b9c24

11 files changed

+110
-79
lines changed

docs/project/wiki/includes/open-wiki-hub.md

Lines changed: 36 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,25 @@
11
---
22
ms.topic: include
3+
ms.date: 06/02/2025
34
---
45

56
## Open the Wiki
67

7-
You can open and view a wiki page for your project.
8+
You can open and view the wiki page for your team project from Azure DevOps in the browser or use the Azure DevOps CLI.
89

910
#### [Browser](#tab/browser)
1011

11-
Connect to your project using a [supported web browser](/azure/devops/server/compatibility#supported-browsers) and choose **Wiki**.
12+
Connect to your project by using a [supported web browser](/azure/devops/server/compatibility#supported-browsers) and select **Wiki**:
1213

13-
:::image type="content" source="../media/open-wiki-vert-brn.png" alt-text="Screenshot showing highlighted Wiki menu selection.":::
14+
:::image type="content" source="../media/open-wiki-overview-page.png" border="false" alt-text="Screenshot of a wiki open in the browser and showing the wiki overview page." lightbox="../media/open-wiki-overview-page.png":::
1415

15-
If you need to switch your team project, choose :::image type="icon" source="../../../media/icons/project-icon.png" border="false"::: **Azure DevOps** to [browse all team projects and teams](../../navigation/work-across-projects.md).
16+
If you need to switch your team project, select :::image type="icon" source="../../../media/icons/project-icon.png"::: **Azure DevOps** to [browse all team projects and teams](../../navigation/work-across-projects.md).
1617

1718
#### [Azure DevOps CLI](#tab/azure-devops-cli)
1819

1920
::: moniker range="azure-devops"
2021

21-
You can view and open a wiki page defined for a project using the `az devops wiki show` command. To get started, see [Get started with Azure DevOps CLI](../../../cli/index.md).
22+
You can view and open a wiki page for a project by using the `az devops wiki show` command:
2223

2324
> [!div class="tabbedCodeSnippets"]
2425
```azurecli
@@ -28,25 +29,33 @@ az devops wiki show --wiki
2829
[--subscription]
2930
```
3031

31-
### Parameters
32+
For more information, see [Get started with the Azure DevOps CLI](../../../cli/index.md).
3233

33-
- **--wiki**: Required. Name or ID of the wiki.
34-
- **--open**: Optional. Open the wiki page in your web browser.
35-
- **--project -p**: Optional. Name or ID of the project.
36-
- **--subscription**: Optional. Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
34+
### Basic parameters
3735

38-
### Example
36+
The following parameters are available for the `wiki show` command:
3937

40-
Open a wiki named 'myprojectwiki'.
38+
| Parameter | Required | Description |
39+
|------------------|:--------:|-------------|
40+
| `--wiki` | Yes | The name or ID of the wiki. |
41+
| `--open` | No | Open the wiki page in your web browser. |
42+
| `--project -p` | No | The name or ID of the project. |
43+
| `--subscription` | No | The name or ID of the subscription. You can configure the default subscription with the `az account set -s NAME_OR_ID` command. |
44+
45+
For more information, see the Azure DevOps CLI [command reference](/cli/azure/devops/wiki#az-devops-wiki-show).
46+
47+
### Example: View the project wiki
48+
49+
The following example shows how to open a wiki named "MyProjectwiki":
4150

4251
> [!div class="tabbedCodeSnippets"]
4352
```azurecli
44-
az devops wiki show --wiki myprojectwiki --open
53+
az devops wiki show --wiki MyProjectwiki --open
4554
```
4655

4756
## View a wiki page
4857

49-
To get the content of a page via the Azure DevOps CLI, enter the `az devops wiki show` command.
58+
You can view the content of a specific page by using the Azure DevOps CLI `az devops wiki show` command:
5059

5160
> [!div class="tabbedCodeSnippets"]
5261
```azurecli
@@ -59,22 +68,25 @@ az devops wiki page show --path
5968
[--version]
6069
```
6170

62-
### Parameters
71+
### More parameters
72+
73+
The following table lists [more parameters](#basic-parameters) for the `wiki show` command when you want to view a specific page:
74+
75+
| Parameter | Required | Description |
76+
|---------------------|:--------:|-------------|
77+
| `--path` | Yes | The fully qualified path for the wiki page. |
78+
| `--include-content` | No | Show the full page content along with the page metadata. |
79+
| `--version -v` | No | The version of the wiki page, which corresponds to the `ETag` entity tag value. |
6380

64-
- **--path**: Required. Path of the wiki page.
65-
- **--wiki**: Required. Name or ID of the wiki.
66-
- **--include-content**: Optional. Include content of the page.
67-
- **--open**: Optional. Open the wiki page in your web browser.
68-
- **--project -p**: Optional. Name or ID of the project.
69-
- **--version -v**: Optional. Version (ETag) of the wiki page.
81+
For more information, see the Azure DevOps CLI [command reference](/cli/azure/devops/wiki#az-devops-wiki-show).
7082

71-
### Example
83+
### Example: View a specific page
7284

73-
Get wiki page content with path 'my wiki' in a wiki named 'myprojectwiki'.
85+
The following example shows how to get content for the "Get Started" page of the "MyProjectwiki" wiki:
7486

7587
> [!div class="tabbedCodeSnippets"]
7688
```azurecli
77-
az devops wiki page show --path 'my wiki' --wiki 'myprojectwiki' --content "Hello World"
89+
az devops wiki page show --path 'Get Started' --wiki 'MyProjectwiki' --content "Hello World"
7890
```
7991

8092
::: moniker-end
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
ms.topic: include
3+
ms.date: 05/30/2025
34
---
45

5-
66
| Category | Requirements |
7-
|--------------|-------------|
8-
| **Project access** | Member of the project where the wiki is located. If you don't have access, request it from your project administrator. Anyone with access to the team project, including [Stakeholders](../../../organizations/security/get-started-stakeholder.md), can view the wiki. |
9-
| **Permissions** | - To add or edit wiki pages: Member of the **Contributors** group.<br> - To publish code as wiki: **Create Repository** permission. By default, this permission is set for members of the [Project Administrators group](../../../repos/git/set-git-repository-permissions.md).|
10-
| **Access levels** | At least **Basic** access. |
7+
|----------|--------------|
8+
| **Project access** | Member of the project where the wiki is located. If you don't have access, request it from your project administrator. Anyone with access to the team project can view the wiki, including [Stakeholders](../../../organizations/security/get-started-stakeholder.md). |
9+
| **Permissions** | - To add or edit wiki pages: Member of the **Contributors** group. <br> - To publish code as wiki: **Create Repository** permission. By default, this permission is set for members of the [Project Administrators group](../../../repos/git/set-git-repository-permissions.md). |
10+
| **Access levels** | At least **Basic** access. |
137 KB
Loading
-42.2 KB
Binary file not shown.
40.8 KB
Loading
-25.6 KB
Binary file not shown.
98.4 KB
Loading
181 KB
Loading

docs/project/wiki/publish-repo-to-wiki.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ For more information, see [Provisioned vs. published code as wiki](provisioned-v
4747
1. Sign in to your project (```https://dev.azure.com/{Your_Organization}/{Your_Project}```) and select **Overview** > **Wiki**.
4848

4949
> [!div class="mx-imgBorder"]
50-
> ![Screenshot showing selection of wiki tab.](media/open-wiki-vert-brn.png)
50+
> ![Screenshot showing selection of wiki tab.](media/open-wiki-overview-page.png)
5151
5252
If you need to switch projects, select :::image type="icon" source="../../media/icons/project-icon.png" border="false"::: **Azure DevOps** to [browse all projects](../navigation/work-across-projects.md).
5353

Lines changed: 67 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,94 @@
11
---
2-
title: Create a project wiki to share information
2+
title: Create Project Wiki to Share Information
33
titleSuffix: Azure DevOps
4-
description: Share information with your team and increase collaboration using a built-in team project wiki in Azure DevOps.
4+
description: Share information with your team and increase collaboration by using a built-in team project wiki in Azure DevOps.
55
ms.subservice: azure-devops-wiki
66
ms.custom: wiki, devx-track-azurecli, devdivchpfy22
77
ms.topic: how-to
88
ms.author: chcomley
99
author: chcomley
1010
ms.reviewer: gopinach
1111
monikerRange: '<= azure-devops'
12-
ms.date: 01/05/2024
12+
ms.date: 06/02/2025
13+
#customer intent: As a developer, I want to work with the built-in project wiki in Azure DevOps, so I can share information with my team and support collaboration.
1314
---
1415

1516
# Create a wiki for your project
1617

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

19-
In this article, learn how to open a wiki and create a Git repo for your wiki. Every team project has a wiki. Use the wiki to share information with your team to understand and contribute to your project.
20+
In Azure DevOps, every team project has a wiki. You can use the wiki to share information with your team and support project contribution. The wiki is powered by a Git repository in the backend. This article describes how to open the project wiki and create the Git repo.
2021

21-
Each team project wiki is powered by a Git repository in the back-end. When you create a team project, a wiki Git repo isn't created by default. Create a Git repository to store your wiki Markdown files, or [publish existing Markdown files from a Git repository](publish-repo-to-wiki.md) to a wiki.
22-
23-
<a id="prereq"> </a>
22+
When you create a team project, a wiki Git repo isn't created by default. You can create the repo to store your wiki Markdown files, or [publish existing Markdown files from a Git repository](publish-repo-to-wiki.md) to a wiki.
2423

2524
## Prerequisites
2625

2726
[!INCLUDE [wiki-prereqs-create-repository](includes/wiki-prereqs-create-repository.md)]
2827

28+
<!-- Section: Open the Wiki -->
2929
[!INCLUDE [temp](includes/open-wiki-hub.md)]
3030

3131
## Create a wiki Git repository
3232

33-
#### [Browser](#tab/browser)
33+
This section describes how to create the Git repo for your wiki. You can work directly with the Azure DevOps UI in the browser or use the Azure DevOps CLI.
3434

35-
Create a new Git repository that stores all your wiki pages and related artifacts. From the wiki landing page, select **Create Project wiki**. Even if you use TFVC for source control, you can create a wiki with a Git repository.
35+
### [Browser](#tab/browser)
3636

37-
::: moniker range="<=azure-devops"
37+
In the browser, you can create a new Git repository to store your wiki pages and related artifacts. From the **Wiki** landing page, select **Create project wiki**. Even if you use Team Foundation Version Control (TFVC) for source control, you can create a wiki with a Git repository.
3838

39-
> [!div class="mx-imgBorder"]
40-
> ![Screenshot of Create wiki, Git repo for your wiki or publish existing repo Markdown files.](media/wiki/create-wiki-or-publish-create-option.png)
41-
::: moniker-end
39+
:::image type="content" source="media/wiki/create-wiki-or-publish-create-option.png" border="false" alt-text="Screenshot that shows how to select the Create project wiki or Publish code as wiki option in Azure DevOps." lightbox="media/wiki/create-wiki-or-publish-create-option.png":::
4240

43-
If you don't have access to create a wiki Git repository or if you don't have access to any of the existing wikis, the following message appears.
41+
If you don't have the necessary permissions to create a wiki Git repo or you can't access any existing wikis, you see the following message:
4442

45-
> [!div class="mx-imgBorder"]
46-
> ![Screenshot of Insufficient permissions to create a wiki repository.](media/wiki/wiki-security-no-contributor.png)
43+
:::image type="content" source="media/wiki/wiki-security-no-contributor.png" alt-text="Screenshot of the message for users with insufficient permissions to create a wiki Git repository.":::
4744

48-
Your administrator can create the wiki Git repository or you can request that they elevate your permissions. Stakeholders can't create a wiki, as they have no permissions to work in **Repos** or **Code**.
45+
Users with Project administrator-level access can create the wiki Git repo. Users with Stakeholder access can't create a wiki because they don't have permissions to work in the **Repos** or **Code** sections of the project.
4946

50-
The wiki Git repo is referred as `TeamProjectName.wiki`. For example, if your team project is `foobar` then the wiki repo is labeled `foobar.wiki`.
47+
The name for your wiki repo is based on your project name. The convention is `<ProjectName>.wiki`. If your team project name is `Contoso` then your wiki repo name is `Contoso.wiki`.
5148

52-
> [!NOTE]
53-
> If you want to create more wikis, then you must [publish code as a wiki](publish-repo-to-wiki.md). You can set up multiple wiki repos within a single project.
49+
> [!TIP]
50+
> You can create multiple wikis for a single project by [publishing your code as a wiki](publish-repo-to-wiki.md).
5451
55-
### How can I go to the Git repository?
52+
#### Access your wiki repo
5653

57-
The *TeamProjectName.wiki* doesn't appear in the drop-down menu of repositories from **Repos** or **Code**. It also isn't in the list provided from the **Project Settings > Repositories** or **Project Settings > Version Control** pages.
58-
However, you can get to it from the following URL:
54+
The Git repository for your wiki (`ProjectName.wiki`) isn't included in the dropdown list of repositories in the **Repos** or **Code** sections of your project. The wiki repo is also not listed in the **Project Settings > Repositories** or **Version Control** pages. Instead, you can access your wiki repo from the **Repos** > **Files** page for your wiki.
5955

60-
::: moniker range="azure-devops"
61-
`https://dev.azure.com/<Org_Name>/<Team_Project_Name>/_git/<Wiki_Name>`
62-
::: moniker-end
56+
1. Create the URL for the **Repos** > **Files** page. In the following URL, substitute your server, organization, project, and wiki name for any `<Placeholder>` portions:
6357

64-
::: moniker range=" < azure-devops"
65-
`https://<Server_Name>/Default_Collection/<Team_Project_Name>/_git/<Wiki_Name>`
66-
::: moniker-end
58+
::: moniker range="azure-devops"
6759

68-
Select **Clone Wiki** from the ellipsis near the wiki picker to access the wiki URL.
60+
`https://dev.azure.com/<Organization>/<ProjectName>/_git/<WikiName>`
6961

70-
:::image type="content" source="media/wiki/clone-wiki.png" alt-text="Screenshot of Clone wiki action.":::
62+
::: moniker-end
63+
::: moniker range=" < azure-devops"
7164

72-
The URL of the wiki Git repository is exposed. Copy and paste it into your web browser to access the underlying Git repo.
65+
`https://<ServerName>/Default_Collection/<ProjectName>/_git/<WikiName>`
7366

74-
#### [Azure DevOps CLI](#tab/azure-devops-cli)
67+
::: moniker-end
7568

76-
::: moniker range="azure-devops"
69+
1. Paste the URL into a browser and open the **Files** page for your wiki.
7770

78-
You can create a wiki with the [az devops wiki create](/cli/azure/devops/wiki#ext-azure-devops-az-devops-wiki-create) command. To get started, see [Get started with Azure DevOps CLI](../../cli/index.md).
71+
1. On the **Repos** > **Files** page, locate your wiki repo name and select **More options** (**...**) > **Clone**.
7972

80-
> [!NOTE]
81-
> To create more than one wiki, you must [publish code as a wiki](./publish-repo-to-wiki.md#publish-a-git-repository-to-a-wiki). You can set up multiple wiki repos within a single project.
73+
:::image type="content" source="media/wiki/wiki-repo-files-select-clone.png" border="false" alt-text="Screenshot that shows how to open the Repos Files page for your wiki repo and then select the Clone option." lightbox="media/wiki/wiki-repo-files-select-clone.png":::
74+
75+
The **Clone** option opens a dialog that includes the URL for your wiki repo.
76+
77+
1. In the dialog, select **HTTP** and then select the **Copy** icon (double page):
78+
79+
:::image type="content" source="media/wiki/clone-wiki-repo-files.png" alt-text="Screenshot that shows how to access the wiki repo URL by selecting the HTTP option and the Copy icon.":::
80+
81+
The URL is copied to your clipboard.
82+
83+
Close the dialog.
84+
85+
1. To access the wiki repo, paste the copied URL into the browser.
86+
87+
### [Azure DevOps CLI](#tab/azure-devops-cli)
88+
89+
::: moniker range="azure-devops"
90+
91+
You can create a wiki with the [az devops wiki create](/cli/azure/devops/wiki#ext-azure-devops-az-devops-wiki-create) command:
8292

8393
```azurecli
8494
az devops wiki create [--mapped-path]
@@ -90,19 +100,28 @@ az devops wiki create [--mapped-path]
90100
[--version]
91101
```
92102

93-
#### Parameters
103+
For more information, see [Get started with Azure DevOps CLI](../../cli/index.md).
104+
105+
> [!NOTE]
106+
> If you want to create more than one wiki, you need to [publish your project code as a wiki](./publish-repo-to-wiki.md#publish-a-git-repository-to-a-wiki). You can set up multiple wiki repos for a single project.
107+
108+
#### Parameters
109+
110+
The following parameters are available for the `wiki create` command. The `type` parameter specifies the type of wiki to create: Project wiki (`projectwiki`) or Publish code as wiki (`codewiki`).
94111

95-
- **mapped-path**: (Required for the **codewiki** type). Mapped path of the new wiki. For example, you can specify `/` to publish from the root of the repository.
96-
- **name**: (Required for the **codewiki** type). Name of the new wiki. If you don't specify a name for type **projectwiki**, then the new wiki gets named `TeamProjectName.wiki`.
97-
- **org**: Azure DevOps organization URL. You can configure the default organization using `az devops configure -d organization=ORG_URL`. Required if not configured as default or picked up using `git config`. Example: `--org https://dev.azure.com/MyOrganizationName/`.
98-
- **project**: Name or ID of the project. You can configure the default project using `az devops configure -d project=NAME_OR_ID`. Required if not configured as default or picked up using `git config`.
99-
- **repository**: (Required for the **codewiki** type). Name or ID of the repository to publish the wiki from.
100-
- **type**: Type of wiki to create. The accepted values are **projectwiki** (default) and **codewiki**.
101-
- **version**: (Required for the **codewiki** type). Repository branch name to publish the code wiki from.
112+
| Parameter | Required | Description |
113+
|---------------|----------|-------------|
114+
| `mapped-path` | Yes (`codewiki`) | The mapped path for the wiki. You can specify backslash (`/`) to publish from the root of the wiki repo. |
115+
| `name` | Yes (`codewiki`) | The name for the wiki. For the `projectwiki` type, when no name is specified, the wiki name is `TeamProjectName.wiki`. |
116+
| `org` | Maybe | The Azure DevOps organization URL. You can configure the default organization with the `az devops configure -d organization=ORG_URL` command. <br> **Note**: When the organization isn't configured by default or picked up by using the `git config` command, the parameter is **Required**. Example: `--org https://dev.azure.com/<OrganizationName>/`. |
117+
| `project` | Maybe | The name or ID of the project. You can configure the default project by using the `az devops configure -d project=NAME_OR_ID` command. <br> **Note**: When the project isn't configured by default or picked up by using the `git config` command, the parameter is **Required**. |
118+
| `repository` | Yes (`codewiki`) | The name or ID of the Git repository to publish the wiki from. |
119+
| `type` | No | The type of wiki to create: Project wiki (`projectwiki`) or Publish code as wiki (`codewiki`). The default is `projectwiki`. |
120+
| `version` | Yes (`codewiki`) | The Git repo branch name to publish the code wiki from. |
102121

103-
#### Example
122+
#### Example: Create a project wiki
104123

105-
The following command creates a wiki named "Fabrikam Fiber" and shows the output in table format.
124+
The following command creates a project wiki named "Fabrikam Fiber" and shows the output in table format:
106125

107126
```azurecli
108127
az devops wiki create --name "Fabrikam Fiber" --output table
@@ -119,7 +138,7 @@ ID Name Type
119138

120139
* * *
121140

122-
## Next steps
141+
## Next step
123142

124143
> [!div class="nextstepaction"]
125144
> [Add and edit wiki pages](add-edit-wiki.md)

0 commit comments

Comments
 (0)