AZ-400: Designing and Implementing Microsoft DevOps Solutions

Configure Collaboration Communication

Documentation with Azure Wikis

Azure Wikis in Azure DevOps deliver an integrated, version-controlled documentation solution. Whether you need a blank canvas for project docs or want to publish existing Markdown alongside your code, Azure Wikis ensure your documentation stays aligned with development.

Overview

Wiki TypeHosted LocationVersioningIdeal Use Case
Provisioned WikiAzure DevOps (managed)Built-in revisionsQuick-start docs, team collaboration
Code-PublishedGit repositoryGit branches/tagsDocs-as-code, CI/CD integration, versioned docs

Creating a New Wiki

  1. In your Azure DevOps project, select Wiki under Overview.

  2. Choose one of the following:

    • Create a project wiki (provisioned wiki)
    • Publish code as wiki

Note

Selecting Publish code as wiki requires a repository with Markdown files and a supported branch.


Provisioned Wiki

A provisioned wiki provides a built-in, managed wiki experience. After creation, you can immediately add content via the Azure DevOps editor.

The image shows a screenshot of a "Provisioned Wiki" in Azure DevOps, displaying a customer portal wiki with a text editor interface.

Key Features

  • Page hierarchy: Add, move, or nest sub-pages
  • Rich editor: Markdown or HTML with image resizing
  • Attachments: Upload files directly to pages
  • Inline comments: Collaborate and discuss changes

The image shows a screenshot of a "Customer Portal Wiki" interface with options to add, edit, or delete pages, and a section for comments.

  • Left pane for quick access to pages and sub-pages
  • Print pages for offline distribution
  • Link work items to documentation
  • View and revert revision history
  • Option to delete the entire wiki

The image shows a screenshot of a "Provisioned Wiki" in Azure DevOps, displaying a customer portal wiki page with navigation options on the left.


Publishing Code as a Wiki

With the code-published approach, your documentation lives in a Git repository, enabling full source-control workflows.

  1. Create a folder (e.g., /docs) in your repo and add .md files.
  2. In Wiki settings, select Publish code as wiki.
  3. Choose the repository and branch.
  4. Save to generate the wiki from your Markdown.

Warning

Editing content directly in the provisioned wiki editor won’t update your Git repository. For changes, commit to your repo branch.

The image shows a guide on publishing code as a wiki, highlighting features like organizing content, browsing, publishing new versions, managing content, and searching the wiki. It also includes a form for setting up a wiki with repository and branch options.

Benefits

  • Folder-based hierarchy and auto-generated table of contents
  • Versioned releases tied to code deployments
  • Pull request reviews for doc updates
  • Searchable, filterable content

Watch Video

Watch video content

Previous
Activity Traceability Dashboards Charts and Widgets