Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019
在 Azure DevOps 中,每个团队项目都有一个 Wiki。 可以使用 Wiki 与团队共享信息,并支持项目贡献。 Wiki 由后端中的 Git 存储库提供支持。 本文介绍如何打开项目 Wiki 并创建 Git 存储库。
创建团队项目时,默认情况下不会创建 Wiki Git 存储库。 可以创建存储库来存储 Wiki Markdown 文件,或 将现有 Markdown 文件从 Git 存储库发布到 Wiki。
先决条件
类别 |
要求 |
项目访问权限 |
Wiki 所在的项目的成员。 如果没有访问权限,请从项目管理员请求它。 有权访问团队项目的任何人都可以查看 Wiki,包括 利益干系人。 |
权限 |
- 若要添加或编辑 wiki 页面:参与者 组的成员。 - 若要将代码发布为 wiki:创建存储库 权限。 默认情况下,此权限是为项目管理员组的成员设置的。 |
访问级别 |
至少具有基本访问权限。 |
打开 Wiki
可以在浏览器中从 Azure DevOps 打开并查看团队项目的 Wiki 页面,也可以使用 Azure DevOps CLI。
可以使用以下命令查看和打开项目的 az devops wiki show
Wiki 页面:
az devops wiki show --wiki
[--open]
[--project]
[--subscription]
有关详细信息,请参阅 Azure DevOps CLI 入门。
基本参数
以下参数可用于 wiki show
命令:
参数 |
必选 |
DESCRIPTION |
--wiki |
是的 |
Wiki 的名称或 ID。 |
--open |
否 |
在 Web 浏览器中打开 Wiki 页面。 |
--project -p |
否 |
项目的名称或 ID。 |
--subscription |
否 |
订阅的名称或 ID。 可以使用命令配置默认订阅 az account set -s NAME_OR_ID 。 |
有关详细信息,请参阅 Azure DevOps CLI 命令参考。
示例:查看项目 Wiki
以下示例演示如何打开名为“MyProjectwiki”的 wiki:
az devops wiki show --wiki MyProjectwiki --open
查看 Wiki 页面
可以使用 Azure DevOps CLI az devops wiki show
命令查看特定页面的内容:
az devops wiki page show --path
--wiki
[--include-content]
[--open]
[--project]
[--subscription]
[--version]
更多参数
下表列出了查看特定页面时命令的更多参数wiki show
:
参数 |
必选 |
DESCRIPTION |
--path |
是的 |
Wiki 页面的完全限定路径。 |
--include-content |
否 |
显示完整页面内容以及页面元数据。 |
--version -v |
否 |
Wiki 页面的版本,对应于 ETag 实体标记值。 |
有关详细信息,请参阅 Azure DevOps CLI 命令参考。
示例:查看特定页面
以下示例演示如何获取“MyProjectwiki”Wiki 的“入门”页的内容:
az devops wiki page show --path 'Get Started' --wiki 'MyProjectwiki' --content "Hello World"
Azure DevOps Server 不支持 Azure DevOps CLI 命令。
创建 Wiki Git 存储库
本部分介绍如何为 Wiki 创建 Git 存储库。 可以直接在浏览器中使用 Azure DevOps UI,也可以使用 Azure DevOps CLI。
在浏览器中,可以创建新的 Git 存储库来存储 Wiki 页面和相关项目。 在 Wiki 登陆页面中,选择“ 创建项目 Wiki”。 即使使用 Team Foundation 版本控制(TFVC)进行源代码管理,也可以使用 Git 存储库创建 Wiki。
如果没有创建 Wiki Git 存储库所需的权限,或者无法访问任何现有 Wiki,则会看到以下消息:
具有 Project 管理员级访问权限的用户可以创建 Wiki Git 存储库。 具有利益干系人访问权限的用户无法创建 Wiki,因为它们无权在项目的 Repos 或 Code 部分中工作。
Wiki 存储库的名称基于项目名称。 约定为 <ProjectName>.wiki
. 如果团队项目名称为 Contoso
,则 Wiki 存储库名称为 Contoso.wiki
.
访问你的维基代码库
Wiki (ProjectName.wiki
) 的 Git 存储库未包含在项目的 Repos 或 Code 部分中存储库的下拉列表中。 Wiki 存储库也不会在 项目设置 > 存储库 或 版本控制 页中列出。 相反,可以从 Wiki 的 Repos>文件 页访问 Wiki 存储库。
创建 Repos>文件 页的 URL。 在以下 URL 中,将服务器、组织、项目和 wiki 名称替换为任何 <Placeholder>
部分:
https://dev.azure.com/<Organization>/<ProjectName>/_git/<WikiName>
https://<ServerName>/Default_Collection/<ProjectName>/_git/<WikiName>
将 URL 粘贴到浏览器中,然后打开 Wiki 的“文件” 页。
在 “存储库>文件 ”页上,找到 Wiki 存储库名称并选择 “更多选项 ”(...) >克隆。
“ 克隆 ”选项将打开一个对话框,其中包含 Wiki 存储库的 URL。
在对话框中,选择 “HTTP ”,然后选择 “复制 ”图标(双页):
URL 将复制到剪贴板。
关闭对话框。
若要访问 Wiki 存储库,请将复制的 URL 粘贴到浏览器中。
可以使用 az devops wiki create 命令创建 wiki:
az devops wiki create [--mapped-path]
[--name]
[--org]
[--project]
[--repository]
[--type {codewiki, projectwiki}]
[--version]
有关详细信息,请参阅 Azure DevOps CLI 入门。
参数
以下参数可用于 wiki create
命令。 该 type
参数指定要创建的 Wiki 的类型:Project wiki (projectwiki
) 或发布代码作为 wiki (codewiki
)。
参数 |
必选 |
DESCRIPTION |
mapped-path |
是 (codewiki ) |
wiki 的映射路径。 可以指定反斜杠(/ )从 Wiki 存储库的根目录发布。 |
name |
是 (codewiki ) |
Wiki 的名称。
projectwiki 对于类型,如果未指定名称,Wiki 名称为 TeamProjectName.wiki . |
org |
可能 |
Azure DevOps 组织 URL。 可以使用 az devops configure -d organization=ORG_URL 命令配置组织的默认设置。
注意:如果组织没有默认配置或没有通过git config 命令选取,则此参数为必需。 示例:--org https://dev.azure.com/<OrganizationName>/ 。 |
project |
可能 |
项目的名称或 ID。 可以使用命令配置默认项目 az devops configure -d project=NAME_OR_ID 。
注意:在默认情况下未配置项目或通过使用git config 命令选取项目时,参数为必需的。 |
repository |
是 (codewiki ) |
要从中发布 Wiki 的 Git 存储库的名称或 ID。 |
type |
否 |
要创建的 Wiki 类型:Project wiki (projectwiki ) 或发布代码作为 wiki (codewiki )。 默认值为 projectwiki 。 |
version |
是 (codewiki ) |
用于发布代码 Wiki 的 Git 存储库分支名称。 |
示例:创建项目 Wiki
以下命令创建名为“Fabrikam Fiber”的项目 wiki,并显示表格式的输出:
az devops wiki create --name "Fabrikam Fiber" --output table
ID Name Type
------------------------------------ ------------------- -----------
7edcc35b-89be-465e-855e-377ba8660af7 Fabrikam Fiber.wiki projectWiki
Azure DevOps Server 不支持 Azure DevOps CLI 命令。
后续步骤