Enterprise の README の作成

README を作成して、Enterprise での変更等をメンバーと共有できます。

この機能を使用できるユーザーについて

Enterprise owners can create and edit an enterprise README.

この記事の内容

Enterprise の README について

Enterprise での変更等をメンバーと共有するために README を作成する必要があります。 たとえば、README を使用すると、メンバーが Enterprise 内のさまざまな Organization について学習したり、重要なリソースへのリンクを共有したり、Enterprise の設定やポリシーに関する情報を共有するのに役立ちます。

Readme は、Enterprise の [Overview] ページに表示されます。これは、Enterprise に移動するときに表示されるランディング ページです。 このページは、Enterprise のメンバーにのみ表示されます。

また、Enterprise 内の Organization に対して README を作成することもできます。パブリックに表示することも、メンバーにのみ表示することもできます。 詳しくは、「Organizationのプロフィールのカスタマイズ」を参照してください。

Enterprise の README の作成

  1. GitHub の右上隅にあるプロフィール写真をクリックします。

  2. ご自分の環境に応じて、[Your enterprise] または [Your enterprises] をクリックし、表示するエンタープライズをクリックします。

  3. [概要] ページで、[README の作成] をクリックします。 README が既にページに存在する場合は、[編集] をクリックします。

  4. README の内容を記述します。 Markdown を使用して、見出し、画像、リストの追加などの記述内容の書式設定を行うことができます。 詳しくは、「基本的な書き方とフォーマットの構文」を参照してください。

    Note

    README では、パブリックにホストされた画像にのみリンクできます。 README に画像をアップロードしたり、プライベート リポジトリからの画像にリンクしたりすることはできません。

  5. [保存] をクリックします。

参考資料