预配的 Wiki 与发布代码作为 Wiki

  • 项目

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

在 Azure DevOps 中，可以在团队项目 Wiki 或发布为代码 Wiki 中维护 Wiki 内容。 通过发布为代码 Wiki，可以维护多个版本控制 Wiki 以支持内容需求，尽管仅当启用了 Azure Repos 时才可用。

虽然这两个选项都在 Git 存储库中维护 Wiki 内容，但添加、更新和管理 Wiki 内容的方式有所不同。

注意

发布代码作为 wiki 功能目前在 Azure DevOps Server 2018 及更高版本中提供。 对于旧版本，只能 为团队项目预配 Wiki。

Wiki 页面菜单选项

使用预配的 Wiki，可以直接在 Wiki 中添加和编辑页面。 对预配的 Wiki 进行的所有内容更新都发生在 Wiki 中。

使用发布代码作为 Wiki，可以从 Repos 或 Code 添加、编辑和更新内容。

下图显示了预配的 Wiki 的选项。 发布为代码 Wiki 页面不支持其中几个选项。

“预配的 Wiki 页面”菜单选项的屏幕截图。

例如， 发布代码的“在存储库 中编辑”选项，因为 wiki 会将你转到 存储库 页面来编辑该特定页面。 汇报你对为 Wiki 选择的分支中的页面进行汇报会自动发布到 Wiki。

支持的功能和操作差异

这两种类型的 Wiki 都支持以下功能：

下表汇总了可能有所不同的操作或功能，具体取决于 Wiki 类型。

操作 预配的 Wiki 将代码发布为 wiki
支持多个 Wiki，名称 wiki ✔
从 Repos>文件或代码>文件添加或编辑页面 ✔
还原到 Wiki 的早期修订 ✔
还原到 Repos 或 Code 的早期修订 ✔ ✔
维护版本控制 Wiki ✔
选择 Wiki 版本 ✔
取消发布代码 Wiki ✔

添加页面

对于这两种类型的 Wiki，请选择“ 新建”页 或 “添加子页”。 有关详细信息，请参阅 “添加和编辑 Wiki 页面”。

导航窗格中的页面序列和页面列表

预配的 Wiki 会在导航窗格中添加或移动页面时自动管理页面序列和页面列表。

若要将发布代码的导航窗格中 的页面列表结构为 wiki，请在根目录下定义 .order 文件，以及包含子页的每个子文件夹或父页。

这两种类型的 Wiki 都遵循相同的文件结构，只是发布代码作为 wiki 需要手动维护页面序列。

有关使用 .order 文件的详细信息，请参阅 Wiki Git 存储库文件和文件结构。

对以前版本的页面修订和还原

在 Wiki 中，可以查看任何 Wiki 页面的修订。 选择“修订”或“查看修订”菜单选项。

但是，还原过程因 Wiki 页面类型而异。

  • 对于预配的 Wiki 页面，请选择“还原”，如还原提交到预配的 Wiki 页面中所述
  • 对于发布作为代码 Wiki 页面，请从本地分支工作并提交拉取请求以更新正在处理的分支。

版本控制并取消发布 Wiki

使用版本控制，可以根据 Git 存储库的版本化分支将不同的内容版本发布到不同的 Wiki。 只有通过向 Wiki 发布代码创建的 wiki 才支持版本控制与取消发布 Wiki。 有关详细信息，请参阅 发布代码 wiki/取消发布代码 Wiki。

删除项目 Wiki

注意

Wiki REST API 不支持删除项目 Wiki。 因此，必须改为删除 Wiki 存储库。

  1. 克隆 Wiki 存储库以备份其所有内容。 “更多”选项包含克隆 Wiki URL，可用于克隆 Wiki。

  2. 获取支持 Wiki 的 git 存储库 ID。 可以使用 REST API 获取项目中的所有 Wiki。

    例如， GET https://fabrikam.visualstudio.com/sampleProject/_apis/wiki/wikis?api-version=4.1 返回项目中的所有 Wiki，以便你可以选择要删除的 Wiki。

  3. 使用 REST API 删除支持 Git 存储库。 使用在上一步中找到的项目 Wiki 的存储库 ID，并 检查双击存储库 ID，因此不要删除错误的存储库 ID。

    例如： DELETE https://fabrikam.visualstudio.com/sampleProject /_apis/git/repositories/{repositoryId}?api-version=4.1

脱机更新 Wiki

你可以脱机工作，也可以在本地分支中更新预配的 Wiki 的内容并发布为代码 Wiki。 有关详细信息，请参阅 脱机克隆和更新 Wiki 页面。