Azure DevOps Services |Azure DevOps Server 2022 および Azure DevOps Server 2019
Azure DevOps では、すべてのチーム プロジェクトに Wiki があります。 Wiki を使用して、チームと情報を共有し、プロジェクトの投稿をサポートできます。 Wiki はバックエンドの Git リポジトリを利用しています。 この記事では、プロジェクト Wiki を開いて Git リポジトリを作成する方法について説明します。
チーム プロジェクトを作成する場合、Wiki Git リポジトリは既定では作成されません。 リポジトリを作成して Wiki Markdown ファイルを格納したり、 Git リポジトリから Wiki に既存の Markdown ファイルを発行 したりできます。
前提条件
カテゴリ |
要求事項 |
プロジェクトへのアクセス |
Wiki が配置されているプロジェクトのメンバー。 アクセス権がない場合は、プロジェクト管理者に依頼してください。 チーム プロジェクトにアクセスできるユーザーはだれでも、 利害関係者を含む Wiki を表示できます。 |
アクセス許可 |
- Wiki ページを追加または編集するには:共同作成者 グループのメンバー。 - コードを wiki として発行するには、リポジトリを作成し、 アクセス許可を設定します。 既定では、このアクセス許可は プロジェクト管理者グループのメンバーに設定されます。 |
アクセス レベル |
少なくとも Basic アクセス。 |
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
コマンドでは、次のパラメーターを使用できます。
パラメーター |
必須 |
説明 |
--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
を示します。
パラメーター |
必須 |
説明 |
--path |
イエス |
Wiki ページの完全修飾パス。 |
--include-content |
いいえ |
ページメタデータと共にページ全体のコンテンツを表示します。 |
--version -v |
いいえ |
ETag エンティティ タグ値に対応する Wiki ページのバージョン。 |
詳細については、Azure DevOps CLI コマンド リファレンスを参照してください。
例: 特定のページを表示する
次の例は、"MyProjectwiki" Wiki の [Get Started]\(開始\) ページのコンテンツを取得する方法を示しています。
az devops wiki page show --path 'Get Started' --wiki 'MyProjectwiki' --content "Hello World"
Azure DevOps CLI コマンドは、Azure DevOps Server ではサポートされていません。
Wiki Git リポジトリを作成する
このセクションでは、Wiki の Git リポジトリを作成する方法について説明します。 ブラウザーで Azure DevOps UI を直接操作することも、Azure DevOps CLI を使用することもできます。
ブラウザーで、Wiki ページと関連する成果物を格納する新しい Git リポジトリを作成できます。
Wiki ランディング ページで、[プロジェクト Wiki の作成] を選択します。 ソース管理に Team Foundation Version Control (TFVC) を使用する場合でも、Git リポジトリを使用して Wiki を作成できます。
Wiki Git リポジトリを作成するために必要なアクセス許可がない場合、または既存の Wiki にアクセスできない場合は、次のメッセージが表示されます。
Project 管理者レベルのアクセス権を持つユーザーは、Wiki Git リポジトリを作成できます。 利害関係者アクセス権を持つユーザーは、プロジェクトの Repos セクションまたは Code セクションで作業する権限がないため、Wiki を作成できません。
Wiki リポジトリの名前は、プロジェクト名に基づいています。 規則は <ProjectName>.wiki
。 チーム プロジェクト名が Contoso
場合、Wiki リポジトリ名は Contoso.wiki
。
Wiki リポジトリにアクセスする
Wiki (ProjectName.wiki
) の Git リポジトリは、プロジェクトの [ リポジトリ ] セクションまたは [コード ] セクションのリポジトリのドロップダウン リストには含まれません。 Wiki リポジトリは、[ プロジェクト設定] > [リポジトリ ] ページまたは [バージョン 管理 ] ページにも表示されません。 代わりに、Wiki の Repos>Files ページから Wiki リポジトリにアクセスできます。
[Repos>Files] ページの URL を作成します。 次の URL の <Placeholder>
部分を、あなたのサーバー、組織、プロジェクト、Wiki 名に置き換えてください。
https://dev.azure.com/<Organization>/<ProjectName>/_git/<WikiName>
https://<ServerName>/Default_Collection/<ProjectName>/_git/<WikiName>
ブラウザーに URL を貼り付け、Wiki の [ファイル ] ページを開きます。
[ Repos>Files ] ページで、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
)。
パラメーター |
必須 |
説明 |
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 CLI コマンドは、Azure DevOps Server ではサポートされていません。
次のステップ