Demo Creating a Wiki

This guide explains how to set up a comprehensive project wiki for Turkey Time—a .NET application designed to share project details and allow users to contribute information. We'll cover two primary methods: creating a wiki using the Azure DevOps menu system and publishing your code as a wiki. Both approaches ensure that your documentation evolves alongside your project.

Method 1: Creating a Wiki via Azure DevOps

The simplest way to build your project wiki is through the Azure DevOps menu system. Under the Overview section, click on "Wiki" to reveal two options: Create Project Wiki and Publish Code as a Wiki. In this section, we focus on creating a wiki directly from the portal.

Step 1: Create a Wiki

Follow these steps to set up your wiki using the menu system:

1. Provide a title for your wiki.
2. Add initial content—start with an "About This Project" section.
3. Use Markdown formatting to style your content; for example, format section headings as H2 elements.
4. Once you are satisfied with your content, save the file.

After saving, you can easily clone the wiki, rename it, or adjust other settings.

Step 2: Secure Your Wiki

Proper security settings ensure that your wiki is accessible only to the intended users. Azure DevOps allows you to manage permissions with granular controls—configuring who can edit content, who has read-write access, and more.

Method 2: Publishing Code as a Wiki

Another effective technique is to publish your wiki content directly from your code repository. This method stores your wiki alongside your code, allowing version control to track changes as your project evolves.

Step 1: Set Up a Wiki within Your Repository

To create a code-based wiki:

1. Open Visual Studio and create a folder named "Wiki" within your project directory.
2. Inside the "Wiki" folder, add a new Markdown file with the desired content for your wiki page.
3. Commit the newly created Markdown file to Azure Repos.

Step 2: Publish Your Code Wiki

After setting up the Markdown file in your repository:

1. Navigate back to the Azure DevOps portal and click on "Publish Code as Wiki".
2. Select the "Wiki" folder from your repository.
3. Provide a name for your wiki page (for example, "Help Page") and click Publish.

Your newly published wiki page will now be accessible within Azure DevOps. This integrated approach simplifies documentation maintenance by synchronizing code updates and documentation changes.

Next Steps

In the next section, we will explore Azure Boards to create a dynamic dashboard for tracking your project's progress. By integrating these tools, you'll streamline both your development and documentation workflows.

Happy documenting!

Additional Resources

• Azure DevOps Documentation
• Markdown Guide