Skip to main content
Skip table of contents

How to view an Azure DevOps wiki in a Confluence page

The how-to guide on how to add and view an Azure DevOps Wiki in a Confluence page

Using the Azure DevOps Wiki macro

You need to ensure the Query/Work Item/Project/Wiki can be accessed by the user who created the personal access token. And the read scope is provided. Talk to your Confluence admin if not sure.

This macro provides an easy way to view Azure DevOps Wiki by embedding them in Confluences pages.

Quick Guide

  1. Copy the Azure DevOps Wiki URL

  2. Paste the Azure DevOps Wiki URL into a Confluence page.

Detailed Guide

Here is an example of how the macro looks in Confluence

image-20241218-230652.png

To add a Wiki macro to Confluence, you require the Azure DevOps Wiki URL.

Go to the Azure DevOps Wiki you wish to display in Confluence as shown below, then copy the URL from the browser.

image-20241218-231151.png

The URL should be in the following format: <BASE_URL>/<ORG>/<PROJECT>/_wiki/wikis/<PROJECT_NAME>.wiki/1/<WIKI_SLUG)

If you are using Microsoft Azure DevOps running On-Premise, you need to make sure you are using the URL accessible from the Internet.

How to Add the Wiki Macro

The easiest way to add a Wiki Macro to a Confluence page, is to simply paste the Azure DevOps Wiki URL into a Confluence page and the macro should populate automatically.

Alternatively, you can open a blank Wiki Macro instance in one of two similar ways.

Typing / followed by the Macro name (e.g. /Wiki) as shown, the macro will populate, allowing you to select it

image-20241218-232740.png

This can also be achieved by typing the name into the ‘Insert elements’ drop down and selecting the macro.

image-20241218-232912.png

Configuring the Wiki Macro

To access the macro configuration sidebar, either click on a newly added blank Wiki macro, or alternatively click on an existing Wiki macro, then click the edit button as shown below

image-20241218-233658.png

Both options will open the Azure DevOps Wiki configuration sidebar to the right.

image-20241218-233804.png

Azure DevOps Wiki url

This is the link to the Azure DevOps Wiki you wish to display

Display Wiki content

Unchecking this box will remove the content and just display the URL.

Display Wiki tree

The Wiki tree shows all the pages the Wiki in question belongs to. Unchecking both the Wiki tree & the Wiki sub-page opens will remove the sidebar to the left of the wiki as shown below.

image-20241219-000736.png

Display Wiki sub-pages

Checking this will provide a drop down with links to each subpage associated with the Wiki as shown below.

image-20241219-000922.png

Demo

You can find a demo of the Wiki macro from YouTube below:

https://youtu.be/GB_6gWQec1M?feature=shared

Updated:

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.