プロジェクト用 Wiki の作成。

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

この記事では、Wiki を開き、Wiki の Git リポジトリを作成する方法について説明します。 すべてのチーム プロジェクトに Wiki があります。 Wiki を使用してチームと情報を共有し、プロジェクトを理解して貢献します。

各チーム プロジェクト Wiki には、バックエンドの Git リポジトリが用意されています。 チーム プロジェクトを作成する場合、Wiki Git リポジトリは既定では作成されません。 Wiki Markdown ファイルを格納する Git リポジトリを作成するか、既存の Markdown ファイル Git リポジトリから wiki に 発行します。

前提条件

• チーム プロジェクトが必要です。 チーム プロジェクトがまだない場合は、 Azure DevOps に作成します。
• Wiki を作成および変更するには、少なくとも Basic アクセス権が必要です。
• Wiki としてコードを発行するには、リポジトリの作成 アクセス許可が必要です 。 既定では、このアクセス許可は プロジェクト管理者グループのメンバーに設定されます。
• 共同作成者セキュリティ グループのメンバーであるすべてのユーザーは、Wiki ページを追加または編集できます。 チーム プロジェクトにアクセスできるユーザー ( stakeholders を含む) は、Wiki を表示できます。

Wiki を開く

プロジェクトの Wiki ページを開いて表示できます。

ブラウザー

サポートされている Web ブラウザーを使用してプロジェクトに接続し、[Wiki] を選択します。

チーム プロジェクトを切り替える必要がある場合は、[Azure DevOps] を選択して、すべてのチーム プロジェクトとチームを参照します。

Azure DevOps CLI

コマンドを使用して、プロジェクトに対して定義された Wiki ページを表示および az devops wiki show 開くことができます。 開始するには、「 Azure DevOps CLI の概要」を参照してください。

az devops wiki show --wiki
                      [--open]
                      [--project]
                      [--subscription]

パラメーター

• --wiki: 必須。 Wiki の名前または ID。
• --open: 省略可能。 Web ブラウザーで Wiki ページを開きます。
• --project -p: 省略可能。 プロジェクトの名前または ID。
• --subscription: 省略可能。 サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

例

'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]

パラメーター

• --path: 必須。 Wiki ページのパス。
• --wiki: 必須。 Wiki の名前または ID。
• --include-content: 省略可能。 ページのコンテンツを含めます。
• --open: 省略可能。 Web ブラウザーで Wiki ページを開きます。
• --project -p: 省略可能。 プロジェクトの名前または ID。
• --version -v: 省略可能。 Wiki ページのバージョン (ETag)。

例

'myprojectwiki' という名前の Wiki のパス 'my wiki' を含む Wiki ページのコンテンツを取得します。

az devops wiki page show --path 'my wiki' --wiki 'myprojectwiki' --content "Hello World"

Wiki Git リポジトリを作成する

ブラウザー

すべての Wiki ページと関連する成果物を格納する新しい Git リポジトリを作成します。 Wiki のランディング ページで、[プロジェクト wiki の作成を選択します。 ソース管理に TFVC を使用する場合でも、Git リポジトリを使用して Wiki を作成できます。

Wiki Git リポジトリを作成するためのアクセス権がない場合、または既存の Wiki にアクセスできない場合は、次のメッセージが表示されます。

管理者は Wiki Git リポジトリを作成することも、アクセス許可の昇格を要求することもできます。 利害関係者は、 Repos または Code で作業する権限がないため、Wiki を作成できません。

Wiki Git リポジトリは、 TeamProjectName.wikiと呼ばれます。 たとえば、チーム プロジェクトが foobar されている場合、wiki リポジトリには foobar.wikiラベルが付けられます。

Note

さらに Wiki を作成する場合は、wiki としてコード 発行する必要があります。 1 つのプロジェクト内に複数の Wiki リポジトリを設定できます。

Git リポジトリに移動するにはどうすればよいですか?

TeamProjectName.wiki は、Repos または Code のリポジトリのドロップダウン メニューには表示されません。 また、 Project Settings > Repositories または Project Settings > Version Control ページから提供される一覧にも含まれません。
ただし、次の URL からアクセスできます。

https://dev.azure.com/<Org_Name>/<Team_Project_Name>/_git/<Wiki_Name>

wiki ピッカーの近くの省略記号から Clone Wiki を選択して、Wiki URL にアクセスします。

Wiki Git リポジトリの URL が公開されています。 それをコピーして Web ブラウザーに貼り付けて、基になる Git リポジトリにアクセスします。

Azure DevOps CLI

az devops wiki create コマンドを使用して wiki を作成できます。 開始するには、「Azure DevOps CLI の概要」を参照してください。

Note

複数の Wiki を作成するには、コード wiki として発行する必要があります。 1 つのプロジェクト内に複数の Wiki リポジトリを設定できます。

az devops wiki create [--mapped-path]
                      [--name]
                      [--org]
                      [--project]
                      [--repository]
                      [--type {codewiki, projectwiki}]
                      [--version]

パラメーター

• mapped-path: ( codewiki 型に必要)。 新しい Wiki のマップされたパス。 たとえば、リポジトリのルートから発行する / を指定できます。
• name: ( codewiki 型に必須)。 新しい Wiki の名前。 type projectwiki の名前を指定しない場合、新しい wiki には TeamProjectName.wiki という名前が付けられます。
• org: Azure DevOps 組織の URL。 az devops configure -d organization=ORG_URL を使用して、既定の組織を構成できます。 既定として設定されていない場合、または git config を使用して取得された場合は必須です。 例: --org https://dev.azure.com/MyOrganizationName/.
• project: プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として設定されていない場合、または git config を使用して取得された場合は必須です。
• repository: ( codewiki 型に必要)。 Wiki を発行するリポジトリの名前または ID。
• type: 作成する Wiki の種類。 指定できる値は、 projectwiki (既定値) と codewiki です。
• version: ( codewiki 型に必要)。 コード 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

次のステップ

Wiki ページの追加と編集