diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md b/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md index e94a147ad2..b923a188f3 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md @@ -62,4 +62,8 @@ The method you choose depends upon your needs, but if you're unsure, we recommen ## Further reading -- [About READMEs](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes) +- "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)" +- "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile#adding-a-member-only-organization-profile-readme)" +{%- ifversion enterprise-readme %} +- "[AUTOTITLE](/admin/managing-your-enterprise-account/creating-a-readme-for-an-enterprise)" +{%- endif %} diff --git a/content/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise.md b/content/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise.md index 939508607c..ce59469b8a 100644 --- a/content/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise.md +++ b/content/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise.md @@ -56,8 +56,10 @@ Enterprise owners who create an organization owned by the enterprise account aut During a trial of {% data variables.product.prodname_ghe_cloud %}, you can create up to three new organizations in your enterprise. {% data reusables.enterprise-accounts.access-enterprise %} - -1. On the **Organizations** tab, above the list of organizations, click **New organization**. +{%- ifversion enterprise-readme %} +1. In the left sidebar, click **Organizations**. +{%- endif %} +1. On the "Organizations" tab, above the list of organizations, click **New organization**. 1. Under "Organization name", type a name for your organization. 1. Click **Create organization**. 1. Optionally, under "Invite owners", type the username of a person you'd like to invite to become an organization owner, then click **Invite**. @@ -72,7 +74,10 @@ During a trial of {% data variables.product.prodname_ghe_cloud %}, you can invit When you invite an organization to join your enterprise account, at least one owner needs to accept the invitation. Then, you must give a final approval for the transfer. After you invite the organization, and before an owner approves the invitation, you can cancel or resend the invitation at any time. {% data reusables.enterprise-accounts.access-enterprise %} -1. On the **Organizations** tab, above the list of organizations, click **Invite organization**. +{%- ifversion enterprise-readme %} +{% data reusables.enterprise-accounts.click-organizations-tab %} +{%- endif %} +1. On the "Organizations" tab, above the list of organizations, click **Invite organization**. 1. Under "Organization name", start typing the name of the organization you want to invite and select it when it appears in the dropdown list. 1. Click **Invite organization**. The organization owners will receive an email inviting them to join the enterprise. 1. After an organization owner has approved the invitation, navigate back to the **Organizations** tab of the enterprise settings. @@ -90,6 +95,9 @@ Enterprise owners can transfer existing organizations between enterprise account {% endnote %} {% data reusables.enterprise-accounts.access-enterprise %} +{%- ifversion enterprise-readme %} +{% data reusables.enterprise-accounts.click-organizations-tab %} +{%- endif %} 1. Next to the organization you want to transfer, select the {% octicon "gear" width="16" aria-label="Organization settings" %} dropdown menu, then click **Transfer organization**. {% data reusables.enterprise-accounts.organization-settings-dropdown %} diff --git a/content/admin/managing-your-enterprise-account/creating-a-readme-for-an-enterprise.md b/content/admin/managing-your-enterprise-account/creating-a-readme-for-an-enterprise.md new file mode 100644 index 0000000000..14d31f0616 --- /dev/null +++ b/content/admin/managing-your-enterprise-account/creating-a-readme-for-an-enterprise.md @@ -0,0 +1,32 @@ +--- +title: Creating a README for an enterprise +intro: 'You can create a README to tell your members what is happening in your enterprise.' +versions: + feature: enterprise-readme +type: how_to +topics: + - Accounts + - Enterprise +permissions: Enterprise owners can create and edit an enterprise README. +shortTitle: Create a README +--- + +## About READMEs for enterprises + +{% data reusables.enterprise.about-readmes %} + +The README is displayed on the enterprise's "Overview" page, which is the page you see when you navigate to the enterprise at `{% data variables.product.product_url %}/enterprises/YOUR-ENTERPRISE`. This page is only visible to members of the enterprise. + +You can also create READMEs for organizations in your enterprise, visible either publicly or only to members. For more information, see "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile)." + +## Creating a README for an enterprise + +{% data reusables.enterprise-accounts.access-enterprise %} +1. On the "Overview" page, click **Create README**. If a README is already present on the page, click **Edit**. +1. Write the content for your README. You can use Markdown to format the content, such as adding headings, images, and lists. For more information, see "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." +1. Click **Save**. + +## Further reading + +- "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)" +- "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme)" diff --git a/content/admin/managing-your-enterprise-account/index.md b/content/admin/managing-your-enterprise-account/index.md index 167e74fce6..a203f6367f 100644 --- a/content/admin/managing-your-enterprise-account/index.md +++ b/content/admin/managing-your-enterprise-account/index.md @@ -5,6 +5,7 @@ versions: ghec: '*' children: - /creating-an-enterprise-account + - /creating-a-readme-for-an-enterprise - /deleting-an-enterprise-account - /changing-the-url-for-your-enterprise shortTitle: Manage enterprise account diff --git a/content/admin/overview/best-practices-for-enterprises.md b/content/admin/overview/best-practices-for-enterprises.md index 31883704b6..a47ef83b96 100644 --- a/content/admin/overview/best-practices-for-enterprises.md +++ b/content/admin/overview/best-practices-for-enterprises.md @@ -47,6 +47,14 @@ We recommend collaborating in organization-owned repositories whenever possible You can manage the display of usernames within your enterprise's private repositories. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/managing-the-display-of-member-names-in-your-organization)." +{% ifversion enterprise-readme %} + +## Create a README + +{% data reusables.enterprise.about-readmes %} For more information, see "[AUTOTITLE](/admin/managing-your-enterprise-account/creating-a-readme-for-an-enterprise)." + +{% endif %} + ## Further reading - "[AUTOTITLE](/repositories/creating-and-managing-repositories/best-practices-for-repositories)" diff --git a/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md b/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md index b4203390f5..1e30360c43 100644 --- a/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md +++ b/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md @@ -37,7 +37,11 @@ To create your enterprise account, start a free 30-day trial of {% data variable You can add any number of new or existing organizations to manage within your enterprise account. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise)." -### 4. Viewing the subscription and usage for your enterprise account +### 4. Creating a README for the enterprise + +{% data reusables.enterprise.about-readmes %} For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/managing-your-enterprise-account/creating-a-readme-for-an-enterprise)." + +### 5. Viewing the subscription and usage for your enterprise account You can view your current subscription, license usage, invoices, payment history, and other billing information for your enterprise account at any time. Both enterprise owners and billing managers can access and manage billing settings for enterprise accounts. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/billing/managing-the-plan-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account)." diff --git a/content/get-started/onboarding/getting-started-with-github-enterprise-server.md b/content/get-started/onboarding/getting-started-with-github-enterprise-server.md index f55284f245..b49d33f255 100644 --- a/content/get-started/onboarding/getting-started-with-github-enterprise-server.md +++ b/content/get-started/onboarding/getting-started-with-github-enterprise-server.md @@ -82,6 +82,14 @@ As an enterprise owner or administrator, you can manage settings on user, reposi {% data reusables.getting-started.enforcing-repo-management-policies %} +{% ifversion enterprise-readme %} + +### 7. Creating a README for the enterprise + +{% data reusables.enterprise.about-readmes %} For more information, see "[AUTOTITLE](/admin/managing-your-enterprise-account/creating-a-readme-for-an-enterprise)." + +{% endif %} + ## Part 3: Building securely To increase the security of {% data variables.location.product_location %}, you can configure authentication for enterprise members, use tools and audit logging to stay in compliance, configure security and analysis features for your organizations, and optionally enable {% data variables.product.prodname_GH_advanced_security %}. diff --git a/content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md b/content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md index a143a6ab60..dcab7931b5 100644 --- a/content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md +++ b/content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md @@ -43,6 +43,10 @@ You can choose what information to include in your organization profile README. You can format text and include emoji, images, and GIFs in your organization profile README by using {% data variables.product.company_short %} Flavored Markdown. For more information, see "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github)." +{% ifversion enterprise-readme %} +If you manage multiple organizations with an enterprise account, you can help members learn about the different organizations in the enterprise by creating an enterprise README. For more information, see "[AUTOTITLE](/admin/managing-your-enterprise-account/creating-a-readme-for-an-enterprise)." +{% endif %} + ## Adding a public organization profile README The content of public `README.md` will appear on your organization's public profile. @@ -102,3 +106,8 @@ You can replace the identicon with an image that represents your organization. T {% data reusables.profile.org_settings %} 1. In the "Gravatar email (Private)" field, enter the email address associated with your Gravatar image. 1. Click **Update profile**. + +## Further reading + +- "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)" +- "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme)" diff --git a/data/features/enterprise-readme.yml b/data/features/enterprise-readme.yml new file mode 100644 index 0000000000..5115b6d84c --- /dev/null +++ b/data/features/enterprise-readme.yml @@ -0,0 +1,6 @@ +# Reference: #13661 +# Enterprise overview page and README + +versions: + ghec: '*' + ghes: '>=3.13' diff --git a/data/reusables/enterprise-accounts/click-organizations-tab.md b/data/reusables/enterprise-accounts/click-organizations-tab.md new file mode 100644 index 0000000000..bd30bf1b22 --- /dev/null +++ b/data/reusables/enterprise-accounts/click-organizations-tab.md @@ -0,0 +1 @@ +1. In the left sidebar, click **Organizations**. diff --git a/data/reusables/enterprise/about-readmes.md b/data/reusables/enterprise/about-readmes.md new file mode 100644 index 0000000000..3931952c59 --- /dev/null +++ b/data/reusables/enterprise/about-readmes.md @@ -0,0 +1 @@ +To help people understand what is happening in your enterprise, you should create a README. For example, you can use a README to help members learn about different organizations in the enterprise, to share links to important resources, or to communicate information about the settings and policies of your enterprise.