codespace での GitHub Docs の操作

GitHub Codespaces を使用して、GitHub Docs のドキュメントで作業できます。

この記事の内容

GitHub Codespaces について

GitHub Codespaces を使用すると、自分のコンピューターから、リモートでホストされている開発環境で作業できます。 作業環境を設定したり、ローカル コンピューターにファイルをダウンロードしたりしなくても、すぐに作業を開始できます。

詳しくは、「GitHub Codespaces の概要」を参照してください。

codespace でのドキュメントの操作

次の手順は、Web 用 Visual Studio Code を使用してファイルを編集するように GitHub Codespaces が設定されていることを前提としています。 別のエディターを設定した場合、手順はよく似ています。 詳しくは、「GitHub Codespaces の既定のエディターを設定する」を参照してください。

  1. GitHub Docs のオープンソース リポジトリ github/docs に移動します。

  2. オープンソース共同作成者の場合は、リポジトリのフォークを作成し、フォークからこの手順の残りの手順に従います。 詳しくは、「リポジトリをフォークする」を参照してください。

  3. 作業するためのブランチを作成します。 詳しくは、「リポジトリ内でブランチを作成および削除する」を参照してください。

  4. リポジトリのメイン ページで、 [ コード] をクリックし、 [BRANCH-NAME に codespace を作成する] をクリックします。

    [codespace の設定] ページが表示されます。 しばらくすると、ブラウザーベースのバージョンの Visual Studio Code が表示されます。

  5. エクスプローラーを使用して、編集するマークダウン ファイルに移動します。 ファイルがアーティクルの場合は、content ディレクトリに配置されます。 ファイルが再利用可能なコンテンツである場合は、data ディレクトリに配置されます。

    ほとんどの場合、content ディレクトリ内のアーティクルへのパスは、URL 内のパスから .md ファイル拡張子を引いたものと一致します。 たとえば、アーティクル https://docs.github.com/en/codespaces/getting-started/quickstart のソースはマークダウン ファイル content/codespaces/getting-started/quickstart.md です。

  6. 必要に応じてマークダウン ファイルを編集します。

  7. 変更を保存します。

  8. ソース管理ビューを使用するか、ターミナルから Git コマンドを使用して、変更をコミットしてプッシュします。 詳しくは、「Git について」を参照してください。

pull request の作成

  1. github.com/github/docs/pulls で、github/docs リポジトリの [pull request] タブに移動します。

  2. [新しい pull request] をクリックします。

  3. オープンソース共同作成者の場合は、 [フォーク間の比較] をクリックし、作成したフォークされたリポジトリと、作業ブランチを選びます。

    それ以外の場合は、"compare" ブランチを自分の作業ブランチに変更します。

  4. 表示された変更に、codespace で行ったすべての変更が含まれることを確認します。 そうでない場合は、codespace から GitHub にプッシュしていない変更があることを示している可能性があります。

  5. [pull request の作成] をクリックします。

  6. pull request の詳細を入力し、 [pull request の作成] をクリックします。

    pull request は、GitHub Docs チームのメンバーによってレビューされます。