Merge pull request #7974 from GitHubber17/wiki-421753-b

v-shils · web-flow · commit e9ea414168ca · 2025-05-28T11:21:41.000-07:00
Freshness: Azure DevOps - Wiki
diff --git a/docs/project/wiki/provisioned-vs-published-wiki.md b/docs/project/wiki/provisioned-vs-published-wiki.md
@@ -1,16 +1,15 @@
 ---
-title: Differences between provisioned and published as code wiki
+title: 'Wiki Differences: Provisioned or Published as Code'
 titleSuffix: Azure DevOps
-description: Understand the differences of updating a provisioned wiki for a team project versus files you publish from a Git repository in Azure DevOps. 
+description: Understand the differences of maintaining an Azure DevOps wiki provisioned for a team project versus a wiki published as code. 
 ms.subservice: azure-devops-wiki
 ms.custom: wiki, devdivchpfy22
-ms.topic: conceptual
-ms.assetid:
+ms.topic: concept-article
 ms.author: chcomley
 ms.reviewer: gopinach
 author: chcomley
-monikerRange: '<= azure-devops'
-ms.date: 08/05/2024  
+ms.date: 05/28/2025
+#customer intent: As an Azure DevOps developer, I want to compare provisioning a wiki with publishing a wiki as code, so I can choose the best approach for my team.
 ---
 
 # Provisioned wiki vs. published as code wiki
@@ -19,110 +18,107 @@ ms.date: 08/05/2024
 
 <!--- Supports https://go.microsoft.com/fwlink/?linkid=866310 -->
 
-You can maintain your wiki content in a [team project wiki](wiki-create-repo.md) or a [published as code wiki](publish-repo-to-wiki.md). With a published as code wiki, you can maintain several versioned wikis to support your content needs, although it's available only if Azure Repos is enabled.
+You can maintain your wiki content in a [team project wiki](wiki-create-repo.md) or a [published as code wiki](publish-repo-to-wiki.md). With a _published as code wiki_, you can maintain several versioned wikis to support your content needs. This option is available when you enable Azure Repos.
 
 While both options maintain the wiki content in Git repositories, the way you add, update, and manage the wiki content differs.
 
-> [!NOTE]  
-> The published as code wiki feature is currently available on Azure DevOps Server 2018 and later versions. For older versions, you can only [provision a wiki for your team project](wiki-create-repo.md).  
+## Maintain wiki content
 
-## Wiki page menu options
+For both types of wiki, you can work directly in GitHub or work offline and then push your changes to the repo. 
 
-With a *provisioned wiki*, you can add and edit pages directly within the **wiki**. All content updates to a *provisioned wiki* occur within the **wiki**.
+For a _provisioned wiki_, you add and maintain wiki pages directly within the **Wiki** > **Pages** section of the repo. All content updates to a _provisioned wiki_ occur within the wiki itself.
 
-With a *published as code wiki*, you can add, edit, and update content from **Repos** or **Code**.
+For a _published as code wiki_, you add and maintain wiki content as code files in the repo. You access the files within the **Repos** or **Code** sections of the repo on GitHub.
 
-The following image shows options for a provisioned wiki. Several of these options aren't supported for the **published as code wiki** pages.
+The following image shows menu options for a _provisioned wiki_:
 
-:::image type="content" source="media/wiki/diff-menu-options-provisioned.png" alt-text="Screenshot of Provisioned wiki page menu options.":::
+:::image type="content" source="media/wiki/diff-menu-options-provisioned.png" alt-text="Screenshot of menu options available for a provisioned wiki from the wiki Pages section.":::
 
-For example, the **Edit in Repos** option for the published as code wiki takes you to the **Repo** page to edit that specific page. Updates that you make to a page in the branch you selected for the wiki get automatically published to the wiki.
+Some menu options aren't supported for _published as code wiki_ pages. For a _published as code wiki_, the **Edit in Repos** option opens the current page, so you can edit the content in place. Updates you make to a page in the selected branch for the wiki automatically publish to the wiki.
 
-## Supported features and operational differences
+## Add wiki pages
 
-Both types of wiki support the following features:
+The **New page** and **Add subpage** menu options are available for both types of wiki in GitHub. For more information, see [Add and edit wiki pages](add-edit-wiki.md#add-a-wiki-page).
 
-- [Markdown format](markdown-guidance.md)
-- [HTML tags](markdown-guidance.md#use-html-tags-in-wiki-pages)
-- [Insert and resize images](markdown-guidance.md#images)
-- [Mathematical notation and characters](markdown-guidance.md#mathematical-notation)
-- [Link to work items using #](markdown-guidance.md#link-to-work-items-from-a-wiki-page)
-- [Attach files](markdown-guidance.md#attach)
-- [Filter Wiki contents](filter-print-wiki.md)
-- [Print a Wiki page](filter-print-wiki.md)
-- [Update content offline](wiki-update-offline.md)
-- [Add or edit pages from the Wiki](add-edit-wiki.md)
+<a id="toc"></a>
 
-The following table summarizes those operations or features that might differ, depending on the wiki type.  
+## Adjust page sequence and page list
 
-> [!div class="mx-tdCol2BreakAll"]
-> |Operation |    Provisioned wiki    | Published as code wiki |
-> |--------|--------------|--------------|  
-> |[Support multiple wikis, name wiki](publish-repo-to-wiki.md)  |  | ✔️|
-> |[Add or edit pages from **Repos** > **Files** or **Code** > **Files**](publish-repo-to-wiki.md) |  |✔️ |
-> |[Revert to an earlier revision from the **Wiki**](wiki-view-history.md#revert-provision) |✔️ |  |
-> |[Revert to an earlier revision from **Repos** or **Code**](wiki-view-history.md#revert-publish) |✔️ |✔️ |
-> |[Maintain versioned wikis](#versioning) |  | ✔️ |
-> |[Select a wiki version](publish-repo-to-wiki.md#select-a-wiki-version) |  | ✔️ |
-> |[Unpublish a code wiki](publish-repo-to-wiki.md#unpublish-wiki) |  | ✔️ |
+Both types of wiki apply the same folder and file structure within the Git repo. The difference is in how you maintain the page sequence.
 
-<a id="add-pages"></a>
+For a *provisioned wiki*, GitHub manages the page sequence and page list automatically as you add or move pages within the navigation pane.
 
-## Add pages
+For a _published as code wiki_, you need to maintain the page sequence **manually**. To structure the list of pages in the navigation pane, you define an _*.order*_ file at the root and for each subfolder or parent page that contains subpages. For more information, see [Wiki Git repository files and file structure](wiki-file-structure.md#order-file).
 
-For both types of wiki, select **New page** or **Add subpage**. For more information, see [Add and edit wiki pages](add-edit-wiki.md#add-a-wiki-page).
+<a id="revisions"></a>
 
-<a id="toc"></a>
+## View page revisions and revert to earlier version
 
-## Page sequence and page list in navigation pane
+From the **Wiki** page for the Git repo, you can view the revisions of any page within the wiki. Use the **Revisions** or **View revisions** menu options. To revert the current page content to an earlier version, the process differs depending on the wiki page type.
 
-The *provisioned wiki* manages the page sequence and page list automatically as you add or move pages within the navigation pane.
+For a *provisioned wiki* page, select the  **Revert** menu option. For more information, see [Revert a commit to a provisioned wiki page](wiki-view-history.md#revert-provision).
 
-To structure the list of pages in the navigation pane for a *published as code wiki*, define the `*.order*` file at the root, and for each subfolder or parent page that contains subpages.
+For a *published as code wiki* page, you work from a local branch and submit a pull request to update the branch you're working from.
 
-Both types of wikis follow the same file structure, it's just that the published as code wiki requires you to maintain the page sequence manually.
+<a id="versioning"></a>
 
-For more information about working with *`.order`* files, see [Wiki Git repository files and file structure](wiki-file-structure.md#order-file).
+## Use versioning and unpublish the wiki
 
-<a id="revisions"></a>
+Versioning support lets you publish different content versions to distinct wikis, based on a versioned branch of a Git repo. 
 
-## Page revisions and reverting to a previous version
+You can version and unpublish a wiki only if you're the user who published the code to create wiki. For more information, see [Unpublish a code wiki](publish-repo-to-wiki.md#unpublish-wiki).
 
-From the **wiki**, you can view the revisions of any wiki page. Select **Revisions** or the **View revisions** menu option.
+## Delete project wiki
 
-But, the revert process differs depending on the wiki page type.  
+The following steps describe how to delete a project wiki.
 
-- For a *provisioned wiki* page, select **Revert**, as described in [Revert a commit to a provisioned wiki page](wiki-view-history.md#revert-provision)
-- For a *published as code wiki* page, work from a local branch and submit a pull request to update the branch you're working from.
+> [!NOTE]
+> You can't use the REST API to delete a project wiki. Instead, delete the wiki repository directly.
 
-<a id="versioning"></a>
+1. Clone the wiki repository to back up all content. You can find the wiki URL on the **More options** menu (**...**).
 
-## Versioning and unpublishing a wiki
+1. Get the Git repository ID associated with your wiki. You can use the [REST API](/rest/api/azure/devops/wiki/wikis/get?view=azure-devops-rest-7.1&tabs=HTTP&preserve-view=true) to get all the wikis in the project.
+   
+   For example, the `GET https://fabrikam.visualstudio.com/sampleProject/_apis/wiki/wikis?api-version=4.1` command returns all wikis in the project. Run the command and choose the wiki to delete.
 
-With versioning, you can publish different content versions to distinct wikis, based on a versioned branch of a Git repo. You can version and unpublish a wiki only if you are the one who created it by publishing code to a wiki. For more information, see [Unpublish a code wiki](publish-repo-to-wiki.md#unpublish-wiki).
+1. Delete the Git repository associated with your wiki by using the REST API. Use the repository ID of the project wiki you found earlier. Double check the repository ID to ensure you don't remove the wrong wiki.
 
-## Delete a project wiki
+   For example, the `DELETE https://fabrikam.visualstudio.com/sampleProject /_apis/git/repositories/<repositoryId>?api-version=4.1` command deletes the wiki. Replace `<repositoryId>` with the repository ID of the wiki to delete.
 
-> [!NOTE]
-> Wiki REST APIs don't support deleting a project wiki. So, you have to delete the wiki repository instead.
+## Update wiki while offline
 
-1. Clone the wiki repository to take backup of all its content. The **More options** has the clone wiki URL, which can be used to clone the wiki.
+You can work offline or in a local branch to update content for both types of wiki. For more information, see [Clone and update wiki pages offline](wiki-update-offline.md).
 
-2. Get the git repository ID that backs your wiki. You can use the [REST API](/rest/api/azure/devops/wiki/wikis/get?view=azure-devops-rest-7.1&tabs=HTTP&preserve-view=true) to get all the wikis in the project.
-   
-   For example, `GET https://fabrikam.visualstudio.com/sampleProject/_apis/wiki/wikis?api-version=4.1` returns all the wikis in the project, so you can choose which one to delete.
+## Explore other features and operations
 
-3. Use the REST API to delete the backing Git repo. Use the repository ID of the project wiki you found in the previous step and double check the repository ID, so you don't remove the wrong one.
+Both types of wiki support several other features and operations:
 
-   For example, `DELETE https://fabrikam.visualstudio.com/sampleProject /_apis/git/repositories/{repositoryId}?api-version=4.1`
+- [Markdown format](markdown-guidance.md)
+- [HTML tags](markdown-guidance.md#use-html-tags-in-wiki-pages)
+- [Insert and resize images](markdown-guidance.md#images)
+- [Mathematical notation and characters](markdown-guidance.md#mathematical-notation)
+- [Link to items with hash tag (#)](markdown-guidance.md#link-to-work-items-from-a-wiki-page)
+- [Attach files](markdown-guidance.md#attach)
+- [Filter Wiki contents](filter-print-wiki.md#filter-wiki-pages)
+- [Print a Wiki page](filter-print-wiki.md#print-a-wiki-page)
+- [Update content offline](wiki-update-offline.md)
+- [Add or edit pages from the Wiki](add-edit-wiki.md)
 
-## Update a wiki offline
+A few operations and features are available for only one type of wiki or the usage approach differs:
 
-You can work offline or in a local branch to update content for a  *provisioned wiki* and *publish as code wiki*. For more information, see [Clone and update wiki pages offline](wiki-update-offline.md).
+> [!div class="mx-tdCol2BreakAll"]
+> |Operation |Provisioned |Published as code |
+> |----------|:----------:|:----------------:|  
+> |[Support multiple wikis, name wiki](publish-repo-to-wiki.md)  |  | ✔️|
+> |[Add or edit pages from **Repos** > **Files** <br> or from **Code** > **Files**](publish-repo-to-wiki.md) |  | ✔️ |
+> |[Revert to earlier revision from **Wiki** page](wiki-view-history.md#revert-provision) | ✔️ |  |
+> |[Revert to earlier revision from **Repos** options <br> or from **Code** options](wiki-view-history.md#revert-publish) | ✔️ | ✔️ |
+> |[Maintain versioned wikis](#versioning) |  | ✔️ |
+> |[Select wiki version](publish-repo-to-wiki.md#select-a-wiki-version) |  | ✔️ |
+> |[Unpublish code wiki](publish-repo-to-wiki.md#unpublish-wiki) |  | ✔️ |
 
-## Related articles
+## Related content
 
-- [Create a wiki for your team project](./wiki-create-repo.md)
+- [Create a wiki for your team project](wiki-create-repo.md)
 - [Wiki Git repository files and file structure](wiki-file-structure.md)
-- [Publish a Git repository to a wiki](publish-repo-to-wiki.md)
-- [Get Started with Git](../../repos/git/gitquickstart.md)
+- [Publish a Git repository to a wiki](publish-repo-to-wiki.md)
