Wiki コンテンツをオフラインで複製および更新する

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

Git リポジトリでコードを開発するのと同じ方法で、Wiki ページをオフラインで更新できます。

必要な任意のクライアントまたは git コマンドライン ツールを使用して、Wiki をオフラインで更新できます。 Git リポジトリの使用とサポートされているツールについて詳しくは、Git リポジトリに関する記事をご覧ください。

Wiki コンテンツをオフラインで更新する基本的な手順は次のとおりです。

  1. ローカル IDE またはワークスペースに Wiki Git リポジトリを複製します。
  2. ローカル Git ブランチにファイルまたはフォルダーを追加します。
  3. ページとサブページを反映するように .order ファイルを更新します。
  4. 行った更新をコミットしてローカル Git ブランチにプッシュします。

前提条件

Markdown ページを別の Wiki からチーム プロジェクト Wiki に移行するか、コードとして Wiki に発行するコンテンツに移行するには、次の手順を実行します。

Wiki を複製する

Wiki リポジトリには、ページ、画像、添付ファイル、ページとサブページのシーケンスが格納されます。 Wiki を複製して開始します。

  1. プロジェクト (https://dev.azure.com/{Your_Organization/Your_Project}) にサインインし、Wiki を選択します。

  2. その他のアクションコンテキスト メニューを開き、 Clone wiki を選択します。

    Wiki Git リポジトリを複製する

  3. Clone リポジトリダイアログで、クリップボードコピーの複製 URL を選択

    Wiki URL をコピーする

    ブラウザーに入力して、wikiMaster ブランチで定義されているファイルを表示します。

    Wiki メイン ファイル

  4. コピーした URL を使用して、使用する IDE でリポジトリを複製します。 詳細については、以下の記事のいずれかを参照してください。

ローカル Git リポジトリにページを追加する

Markdown 形式を使用してページを作成します。 Wiki に追加するページとサブページごとに、ローカル ブランチに Markdown ファイルを追加します。

ページを追加する

Wiki ツリーのルートにページを追加するには、Git リポジトリのルートに Markdown ファイルを追加します。

  1. 追加するページごとに、ページの内容を含む Markdown ファイルを作成し、リポジトリのルート フォルダーの下に追加します。

    CanaryBuilds チーム プロジェクトの場合は、次のフォルダーにあります。

    C:\Users\UserName\Source\Repos\CanaryBuilds.wiki

  2. Wiki ツリーのルートにページを追加するには、Git リポジトリのルートにある各ページの Markdown ファイルを追加します。

    ローカル ブランチ Wiki Git リポジトリ

  3. ルートに追加するすべてのページを追加したら、ルートにある .order ファイルを更新します。 ルートで定義されている Markdown ファイルごとに 1 つのエントリが必要です。 各エントリは、ファイルタイトルとスペースをダッシュで置き換えたものに一致する必要があります。

    次に例を示します。

     Welcome
     Roadmap  
     How-to-contribute  
     Home  
     Reference  
    

サブページを追加する

  1. 親ページのフォルダーを作成し、フォルダー内の各サブページの Markdown ファイルを追加します。

    たとえば、次のファイルを投稿方法フォルダーに追加しました。 これらのサブページは Wiki の [投稿方法] ページの下に表示されます。

    サブページのスクリーンショット。

  2. .orderファイルを、wiki に表示されるサブページの順序でフォルダーに追加します。 ページのシーケンスに .order ファイルを使用する方法については、「 Wiki Git リポジトリ ファイルとファイル構造を参照してください。

    たとえば、ファイルには次のサブページがあります。

     Request-extensions  
     Licensing  
     Smoke-test  
     Coding-guidelines  
    

変更をプッシュする

すべての更新が完了したら、ファイルを Git リポジトリに pushします

追加されたページとサブページは、Wiki にすぐに表示されます。

Wiki ツリーが更新されました

プロセスにエラーがある場合、ページは Wiki に警告記号と共に表示されます。

.order ファイルが正しく更新されない場合の警告。