|
1 | 1 | --- |
2 | | -title: Clone and update wiki content offline |
| 2 | +title: Clone and Update Wiki Content Offline |
3 | 3 | titleSuffix: Azure DevOps |
4 | | -description: Add and update pages offline for your built-in team project wiki in Azure DevOps |
| 4 | +description: Add and update pages offline for your built-in team project wiki in Azure DevOps. |
5 | 5 | ms.subservice: azure-devops-wiki |
6 | 6 | ms.custom: wiki, devdivchpfy22 |
7 | | -ms.topic: conceptual |
| 7 | +ms.topic: concept-article |
8 | 8 | ms.assetid: |
9 | 9 | ms.author: chcomley |
10 | 10 | author: chcomley |
11 | 11 | ms.reviewer: gopinach |
12 | 12 | monikerRange: "<=azure-devops" |
13 | | -ms.date: 01/05/2024 |
| 13 | +ms.date: 06/06/2025 |
| 14 | +#customer intent: As an Azure DevOps developer, I want to author pages offline for my team project wiki, so I can work in my local branch before pushing changes to the main repo. |
14 | 15 | --- |
15 | 16 |
|
16 | 17 | # Clone and update wiki content offline |
17 | 18 |
|
18 | 19 | [!INCLUDE [version-lt-eq-azure-devops](../../includes/version-lt-eq-azure-devops.md)] |
19 | 20 |
|
20 | | -You can update your wiki pages offline the same way you develop code in a Git repo. |
| 21 | +The process for updating wiki offline is the same as developing code in a Git repository. You can use your preferred client and git command-line tools to update your wiki pages offline. For details on working with Git repositories and supported tools, see the [Azure Repos Git Documentation](../../repos/git/index.yml). |
21 | 22 |
|
22 | | -You can use any client you want or git command-line tools to update your wiki offline. For details on working with Git repositories and supported tools, see [Git Repositories](../../repos/git/index.yml). |
| 23 | +The basic steps to update wiki content offline include: |
23 | 24 |
|
24 | | -The basic steps to update wiki content offline are as follows: |
| 25 | +1. [Clone your wiki Git repo to your local interactive development environment (IDE) or workspace](#clone-your-wiki). |
25 | 26 |
|
26 | | -1. [Clone your wiki Git repo to your local IDE or workspace.](#clone-your-wiki) |
27 | | -2. [Add files or folders to your local git branch.](#add-pages) |
28 | | -3. Update the *.order* files to reflect your pages and subpages. |
29 | | -4. [Commit and push the updates you made to your local git branch.](#push-your-changes) |
| 27 | +1. [Add files or folders to your local Git repo branch](#add-pages). |
| 28 | + |
| 29 | +1. Update the _.order_ files to reflect the sequence changes for pages and subpages. |
| 30 | + |
| 31 | +1. [Commit and push the updates to your local Git branch](#push-your-changes). |
30 | 32 |
|
31 | 33 | ## Prerequisites |
32 | 34 |
|
33 | 35 | | Category | Requirements | |
34 | | -|--------------|-------------| |
35 | | -| **Project access** | Member of the project where the wiki's located. If you don't have access, request it from your project administrator. | |
36 | | -| **Permissions** | - 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). | |
37 | | -| **Access levels** | At least **Basic** access. | |
38 | | -|**Tasks** |- [Understand the underlying structure of your wiki Git repo](wiki-file-structure.md) <br> - Understand the [differences between provisioned wiki and publish code as wiki](provisioned-vs-published-wiki.md) | |
39 | | - |
40 | | -<a id="edit-wiki-offline"></a> |
| 36 | +|----------|--------------| |
| 37 | +| **Project access** | Member of the project where the wikis located. You can request access from your Project Administrator, as needed. | |
| 38 | +| **Permissions** | - 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). | |
| 39 | +| **Access levels** | At least **Basic** access. | |
| 40 | +| **Tasks** | - [Understand the underlying structure of your wiki Git repo](wiki-file-structure.md). <br> - Understand the [differences between a provisioned wiki and a published code as wiki](provisioned-vs-published-wiki.md). | |
41 | 41 |
|
42 | 42 | ## Clone your wiki |
43 | 43 |
|
44 | 44 | Your wiki repository stores pages, images, attachments, and the sequence of pages and subpages. Clone your wiki to begin. |
45 | 45 |
|
46 | | -1. Sign in to your project (`https://dev.azure.com/{Your_Organization/Your_Project}`) and then select your wiki. |
| 46 | +1. Sign in to your project (`https://dev.azure.com/<Organization>/<Project>`). |
| 47 | + |
| 48 | +1. Select your wiki, then select **More actions** (*...*) > **Clone wiki**: |
47 | 49 |
|
48 | | -2. Open the **More actions** context menu and select **Clone wiki**. |
| 50 | + :::image type="content" source="media/wiki/more-clone-wiki.png" alt-text="Screenshot that shows how to select the More options Clone wiki Git action for the selected wiki."::: |
49 | 51 |
|
50 | | - :::image type="content" source="media/wiki/more-clone-wiki.png" alt-text="Clone wiki Git repository"::: |
| 52 | +1. In the **Clone repository** dialog, select the **Copy clone URL to clipboard** :::image type="icon" source="../../media/icons/copy-clone-icon.png"::: icon: |
51 | 53 |
|
52 | | -3. From the **Clone repo** dialog, select :::image type="icon" source="../../media/icons/copy-clone-icon.png" border="false"::: **Copy clone URL to clipboard**. |
| 54 | + :::image type="content" source="media/wiki/copy-clone-url-to-clipboard.png" alt-text="Screenshot that shows the wiki repository to clone in the Clone repository dialog."::: |
53 | 55 |
|
54 | | - :::image type="content" source="media/wiki/copy-clone-url-to-clipboard.png" alt-text="Copy the wiki url"::: |
| 56 | +1. Paste the URL into your browser. The Git repository page opens where you can view the files defined under the wikiMain branch. The following example shows the files in the Git repo for the CanaryBuilds project: |
55 | 57 |
|
56 | | - Enter it in your browser to view the files defined under the wikiMaster branch. |
| 58 | + :::image type="content" source="media/wiki/work-offline-wiki-main-branch-files.png" alt-text="Screenshot that shows the Git repository page with the files defined under the wikiMain branch."::: |
57 | 59 |
|
58 | | - :::image type="content" source="media/wiki/work-offline-wikiMaster-files.png" alt-text="Wiki main files"::: |
| 60 | + > [!IMPORTANT] |
| 61 | + > The **Generate Git Credentials** feature is planned for removal. Review the Git Authentication documentation for all authentication methods available to you for git clone operations. |
59 | 62 |
|
60 | | - > [!IMPORTANT] |
61 | | - > The "Generate Git Credentials" button will be removed in January 2025, to reduce creation of unnecessary and underutilized personal access tokens. Review the Git Authentication docs for all authentication methods available to you for git clone operations. |
| 63 | +1. Use the URL that you copied to clone the repo in your preferred IDE. For more information, see the following articles: |
62 | 64 |
|
63 | | -4. Use the URL that you copied to clone the repo in the IDE that you use. For more information, see one of the following articles: |
64 | | - - [Clone an existing Git repo](../../repos/git/clone.md) |
65 | | - - [Using Version Control in VS Code](https://code.visualstudio.com/docs/editor/versioncontrol) |
66 | | - - [Get Started with Git and Azure DevOps](../../repos/git/gitquickstart.md?tabs=visual-studio) |
| 65 | + - [Clone an existing Git repo](../../repos/git/clone.md) |
| 66 | + - [Use Version Control in Visual Studio Code](https://code.visualstudio.com/docs/editor/versioncontrol) |
| 67 | + - [Get started with Git and Azure DevOps](../../repos/git/gitquickstart.md?tabs=visual-studio) |
67 | 68 |
|
68 | 69 | ## Add pages to your local Git repository |
69 | 70 |
|
70 | | -We author pages using [Markdown format](./markdown-guidance.md). Add a Markdown file to your local branch for each page and subpage that you want to add to your wiki. |
| 71 | +Git repo pages are formatted as [Markdown](./markdown-guidance.md) (_.md_) files. For each page you want to add to your wiki, you create a Markdown file in your local branch. After you add pages, you update the _.order_ file to adjust the page sequence to include the new pages. |
71 | 72 |
|
72 | 73 | ### Add pages |
73 | 74 |
|
74 | | -To add pages at the root of the wiki tree, add a Markdown file at the root of the Git repository. |
| 75 | +You can add pages at the top of the wiki structure in the root (`\`) folder and also in other folders. |
75 | 76 |
|
76 | | -1. For each page you want to add, create a Markdown file with the page contents, and then add it under the root folder for your repo. |
| 77 | +1. Create the Markdown (_.md_) file with the content for the new page. In most cases, the file name matches the page title. In the file name, replace any spaces in the title with hyphens (`-`). For more information about creating page content, see [Add a wiki page](add-edit-wiki.md#add-a-wiki-page). |
77 | 78 |
|
78 | | - For the CanaryBuilds team project, it's in the following folder: |
| 79 | +1. Place the file in the desired folder within the wiki structure in your local branch, such as the root folder. The CanaryBuilds project example root folder is `C:\Users\UserName\Source\Repos\CanaryBuilds.wiki`: |
79 | 80 |
|
80 | | - `C:\Users\UserName\Source\Repos\CanaryBuilds.wiki` |
| 81 | + :::image type="content" source="media/wiki/add-pages.png" alt-text="Screenshot that shows the local branch of the wiki Git repo for the CanaryBuilds project."::: |
81 | 82 |
|
82 | | -2. To add pages at the root of the wiki tree, add a Markdown file for each page at the root of the Git repository. |
| 83 | +1. Update the _.order_ file in the same folder where you placed the new page file. The entry text for the page is the file name without the Markdown extension (_.md_). The CanaryBuilds project example adds the new page "How to contribute," which corresponds to the entry text _How-to-contribute_: |
83 | 84 |
|
84 | | - :::image type="content" source="media/wiki/add-pages.png" alt-text="Local branch wiki Git repo"::: |
| 85 | + ``` |
| 86 | + Welcome |
| 87 | + Roadmap |
| 88 | + How-to-contribute |
| 89 | + Home |
| 90 | + Reference |
| 91 | + ``` |
85 | 92 |
|
86 | | -3. After you added all the pages you want to add at the root, update the **.order** file at the root. It should have one entry for each Markdown file that is defined at the root. Each entry should match the file title with spaces replaced with a dash. |
87 | | - |
88 | | - For example: |
89 | | - |
90 | | - ``` |
91 | | - Welcome |
92 | | - Roadmap |
93 | | - How-to-contribute |
94 | | - Home |
95 | | - Reference |
96 | | - ``` |
| 93 | + For more information about the _.order_ file, see [Page sequence and the .order file](wiki-file-structure.md#page-sequence-and-the-order-file). |
97 | 94 |
|
98 | 95 | ### Add subpages |
99 | 96 |
|
100 | | -1. Create a folder for the parent page, and then add Markdown files for each subpage in the folder. |
| 97 | +You can also create subpages for a page in your wiki: |
| 98 | + |
| 99 | +1. Create a folder to serve as the parent page. For more information, see [Repository files and folder structure](wiki-file-structure.md#repository-files-and-folder-structure). |
101 | 100 |
|
102 | | - For example, we added the following files to the How-to-contribute folder. These subpages appear under the How to contribute page in the wiki. |
| 101 | +1. Create the Markdown file for each subpage and place the file in the parent page folder. The CanaryBuilds project example adds the _How-to-contribute_ folder as the parent page: |
103 | 102 |
|
104 | | - :::image type="content" source="media/wiki/add-sub-pages.png" alt-text="Screenshot of the subpages."::: |
| 103 | + :::image type="content" source="media/wiki/add-sub-pages.png" alt-text="Screenshot that shows the How-to-contribute folder in the CanaryBuilds project with new subpages."::: |
105 | 104 |
|
106 | | -2. Add a **.order** file in the folder with the order of the subpages as they should appear in the wiki. To understand the use of the **.order** file to sequence pages, see [Wiki Git repository files and file structure](wiki-file-structure.md). |
107 | | - |
108 | | - For example, the file has the following subpages: |
| 105 | +1. Create a _.order_ file in the parent page folder to define the sequence for the subpages as they should display in the wiki. The example shows a possible order of subpages: |
109 | 106 |
|
110 | | - ``` |
111 | | - Request-extensions |
112 | | - Licensing |
113 | | - Smoke-test |
114 | | - Coding-guidelines |
115 | | - ``` |
| 107 | + ``` |
| 108 | + Request-extensions |
| 109 | + Licensing |
| 110 | + Smoke-test |
| 111 | + Coding-guidelines |
| 112 | + ``` |
116 | 113 |
|
117 | 114 | ## Push your changes |
118 | 115 |
|
119 | | -When you're done with all your updates, [push the files to the Git repository](../../repos/git/pushing.md). |
| 116 | +When your local updates are ready, [push the files to the Git repository](../../repos/git/pushing.md). |
120 | 117 |
|
121 | | -The added pages and subpages appear immediately in your wiki. |
| 118 | +The added pages and subpages appear immediately in your wiki. The following example shows the updates for the CanaryBuilds project: |
122 | 119 |
|
123 | | -:::image type="content" source="media/wiki/wiki-tree-updated-offline.png" alt-text="Wiki tree updated"::: |
| 120 | +:::image type="content" source="media/wiki/wiki-tree-updated-offline.png" alt-text="Screenshot that shows the updated wiki structure for the CanaryBuilds project."::: |
124 | 121 |
|
125 | | -If there are any errors in the process, the pages appear in your wiki with a warning sign. |
| 122 | +If there are any errors in the process, the page appears in your wiki file list with a **Warning** symbol: |
126 | 123 |
|
127 | | -:::image type="content" source="media/wiki/wiki-offline-order-warning.png" alt-text="Warning when .order file isn't updated properly."::: |
| 124 | +:::image type="content" source="media/wiki/wiki-offline-order-warning.png" alt-text="Screenshot that shows a page with an error as indicated by the Warning symbol."::: |
128 | 125 |
|
129 | | -## Related articles |
| 126 | +## Related content |
130 | 127 |
|
131 | | -- [Create a wiki for your team project](wiki-create-repo.md) |
132 | 128 | - [Wiki Git repository files and file structure](wiki-file-structure.md) |
133 | 129 | - [Clone an existing Git repo](../../repos/git/clone.md) |
134 | | -- [Share code with push](../../repos/git/pushing.md) |
135 | | -- [Manage README and Wiki permissions](manage-readme-wiki-permissions.md) |
136 | | -- [Syntax guidance for Markdown files, widgets, wikis, and pull request comments](./markdown-guidance.md). |
| 130 | +- [Syntax guidance for Markdown files, widgets, wikis, and pull request comments](./markdown-guidance.md) |
0 commit comments