ドキュメント用にローカル Git リポジトリを設定する

この記事では、Microsoft のドキュメントに投稿することを目的として、ローカル コンピューター上に Git リポジトリを設定する手順について説明します。 共同作成者は、ローカルに複製されたリポジトリを使用して、新規記事の追加、既存の記事の大幅な編集、またはアートワークの変更を行うことができます。

投稿を開始するには、次の 1 回限りのセットアップ アクティビティを実行します。

• 適切なリポジトリを決定する。
• GitHub アカウントにリポジトリをフォークする。
• 複製されたファイルのローカル フォルダーを選択する。
• ローカル コンピューターにリポジトリを複製する。
• アップストリームのリモート値を構成する。

重要

軽微な変更しか加えていない場合は、この記事の手順を完了する必要はありません。 ツールをインストールせずにクイック編集する方法については、「ブラウザーで編集」を参照してください。

概要

Microsoft Learn のドキュメントに投稿するには、対応するドキュメント リポジトリを複製して、マークダウン ファイルをローカルで作成および編集します。 Microsoft では、GitHub アカウントに適切なリポジトリをフォークすることを要求しています。それにより、予定している変更を保存するための読み取り/書き込みのアクセス許可が付与されます。 その後、pull requests (PR) を使用して、変更を読み取り専用の一元的な共有リポジトリにマージします。

Microsoft リポジトリは、アップストリーム リポジトリと呼ばれます。 GitHub ユーザー インターフェイス内でフォーク アクションを使用すると、ユーザーは Microsoft リポジトリを独自の GitHub アカウントにフォークします。 このフォークは Origin と呼ばれます。 git cloneを使用して、ユーザーは Origin をローカル コンピューターにクローンします。 最後に、ユーザーは git リモート追加アップストリームを使用してローカル クローンを Microsoft アップストリーム リポジトリに接続します。

リポジトリを決定する

Microsoft Learn でホストされているドキュメントは、GitHub のさまざまなリポジトリに存在します。

1. 記事が存在するリポジトリがわからない場合は、Web ブラウザーを使用して記事にアクセスしてください。 記事の右上隅にある [編集] リンク (鉛筆のアイコン) を選択します。

   

2. このアクションにより、GitHub 上のソース ファイルに移動します。 リポジトリ名はページの左上端に表示されます。

   

   次に、公開投稿に使用できる、よく使用されるリポジトリをいくつか示します。

   • Microsoft Learn コミュニティ コンテンツ https://github.com/MicrosoftDocs/community-content/
   • Azure ドキュメントhttps://github.com/MicrosoftDocs/azure-docs
   • SQL Server ドキュメントhttps://github.com/MicrosoftDocs/sql-docs
   • Visual Studio ドキュメントhttps://github.com/MicrosoftDocs/visualstudio-docs
   • .NET ドキュメントhttps://github.com/dotnet/docs
   • Azure .NET SDK ドキュメント https://github.com/azure/azure-docs-sdk-dotnet
   • ConfigMgr ドキュメント https://github.com/MicrosoftDocs/SCCMdocs

リポジトリのフォーク

正しいリポジトリを特定したら、次の手順では、リポジトリを独自の GitHub アカウントにフォークします。

リポジトリをフォークすることは、それのコピーを自分の GitHub アカウントに作成することを意味します。 すべての Microsoft ドキュメント リポジトリで読み取り専用アクセスが提供されますが、フォークでは変更を行う書き込みアクセス権が付与されるため、個人用フォークが必要です。 フォークを使用すると、フォークから Microsoft リポジトリに PR を開くことができます。

1. メイン リポジトリの GitHub ページから、右上隅の [フォーク] ボタンを選択します。

   

2. [新しいフォークの作成] 画面で、[所有者] がユーザー名に設定されていること、および [メイン ブランチのみをコピーする] がチェックされていることを確認します。 必要に応じて、[リポジトリ名] フィールドと [説明] フィールドを変更します。

   

リポジトリの複製

複製 とは、ローカル コンピューター上にリポジトリのコピーを作成することです。

警告

1. ローカル リポジトリを OneDrive 同期フォルダーに複製しないでください。 リポジトリを複製するフォルダーを選択するときは、OneDrive と同期するフォルダー (ドキュメント フォルダーなど) は避けてください。 OneDrive では、変更を メイン ブランチにマージすると、意図しないマージの競合が発生する可能性があります。 代わりに、C:\ ドライブに短いファイルパス (C:\GitHub など) を作成することをお勧めします。

2. Git on Windows: 長いパス名を有効にする。 既定で、Git for Windows では長いファイルパスのサポートが無効になっており、宛先パスが 255 文字を超えるファイルはクローンされません。 次のコマンドを 管理者として実行することにより、長いファイルパスを有効にしてこの問題を回避できます。
   git config --global core.longpaths true

1. ローカル コンピューターに GitHub フォルダーを作成します。 たとえば、「C:\GitHub」とします。 (OneDrive 同期フォルダーに複製しないでください。)

2. ブラウザーで GitHub.com にアクセスして、サインインします。

3. 右上の GitHub で、プロファイルのドロップダウンから [リポジトリ] を選択します。 リポジトリ ページに、フォークされたリポジトリの一覧が表示されます。

4. 複製するリポジトリを選択します。 自分のフォークのリポジトリ ページが表示されます。

   必ず、現在表示されているのが、自分のフォークされたリポジトリのページであり、運用リポジトリのページでないことを確認してください。現在表示されているのが、フォークされたリポジトリのページであるかどうかは、URL で確認できます。Microsoft の組織ではなく、自分の GitHub ユーザー名が表示されている必要があります (正しい例: https://github.com/nancydavolio/azure-docs と誤った例: https://github.com/MicrosoftDocs/azure-docs)。 また、左上隅に自分の名前が表示され、フォーク元の後にメイン リポジトリの名前が続くメモが表示されます。

   

5. ページの左上にある [<> コード] タブを選びます。

6. 右側の [コード] ドロップダウンから、[HTTPS] オプションの下の URL をコピーします。

   

重要

GitHub UI を使用して複製 URL をコピーしました。 残りの手順は VS Code ターミナルで実行する必要があります。

Visual Studio Code から複製するには

1. Visual Studio Code を開きます。

2. 上部のナビゲーション メニューから [表示] を選択し、[ターミナル] を選択します。 ターミナル ビューが Visual Studio Code 画面の下部に表示されます。

3. ターミナル ビューで、コマンドを実行して、「リポジトリの複製」セクションの手順 1 で、ドライブ上のリポジトリ用に作成した GitHub フォルダーにディレクトリ (cd) を変更します。

   例:

    cd C:\GitHub
   

   エラーが発生した場合は、ディレクトリを一度に 1 つのフォルダーに変更する必要があります。

4. 次のコマンドを実行して、リポジトリを複製します。

   git clone <paste the clone URL you copied via the GitHub UI>
   

   次に例を示します。

   git clone https://github.com/nancydavolio/azure-docs.git
   

5. ブラウザー経由で認証を求められたら、[ブラウザーでサインイン] ボタンを選択し、プロセスを完了します。 ブラウザー機能経由の認証をサポートする最新バージョンの Git を必ずダウンロードしてください。 GitHub 個人用アクセス トークンを使用する場合は、次の手順に従ってトークンを作成できます: 個人用アクセス トークンの作成。

   clone コマンドにより、リポジトリ ファイルを自分のフォークから、手順 3 で選択した場所の新しいフォルダーにダウンロードします。 新しいフォルダーは現在のフォルダー内に作成されます。 リポジトリのサイズによっては数分かかることがあります。 処理が終了したらフォルダーを調べて構造を確認することができます。

リモートを設定する

レポジトリを複製した後に、upstream という名前のメイン リポジトリへの読み取り専用のリモート接続をセットアップします。 リモートは、リモート リポジトリを指すエイリアスです。 オリジンはフォークを指し、アップストリームは運用リポジトリを指します。 clone コマンドを実行すると、Git によって origin リモートが自動的に作成されます。 upstream URL を使用して、他のユーザーが行った最新の変更と、ローカル リポジトリを常に同期しておくことができます。

Git Bash または VS Code ターミナルのいずれかで、次のコマンドを実行します。

1. clone コマンドが作成したリポジトリ フォルダーにディレクトリ (cd) を変更します。 次に例を示します。

   cd repo-name
   

2. 次のコマンドを実行して、運用リポジトリを指す upstream という名前のリモートを追加します。 たとえば、upstream リポジトリの URL は https://github.com/MicrosoftDocs/azure-docs.git であり、https://github.com/nancydavolio/azure-docs.git ではありません。

   git remote add upstream <the clone URL of the main repo>
   

   次に例を示します。

   git remote add upstream https://github.com/MicrosoftDocs/azure-docs.git
   

3. 次のコマンドを実行して、リモートが正しいことを確認します。

   git remote -v
   

   出力の例:

   origin  https://github.com/nancydavolio/azure-docs.git (fetch)
   origin  https://github.com/nancydavolio/azure-docs.git (push)
   upstream        https://github.com/MicrosoftDocs/azure-docs.git (fetch)
   upstream        https://github.com/MicrosoftDocs/azure-docs.git (push)
   

4. 間違えた場合は、リモートを削除し、手順を繰り返して追加します。 upstream を削除するには、次のコマンドを実行します。

   git remote remove upstream
   

次のステップ

• ローカル複製を設定したので、次は主要な変更を加えていきましょう。