Skip to content

Commit 0c5208c

Browse files
authored
Enterprise READMEs (GA) (#49362)
1 parent 6a94b2d commit 0c5208c

File tree

11 files changed

+87
-5
lines changed

11 files changed

+87
-5
lines changed

content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,4 +62,8 @@ The method you choose depends upon your needs, but if you're unsure, we recommen
6262

6363
## Further reading
6464

65-
- [About READMEs](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)
65+
- "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)"
66+
- "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile#adding-a-member-only-organization-profile-readme)"
67+
{%- ifversion enterprise-readme %}
68+
- "[AUTOTITLE](/admin/managing-your-enterprise-account/creating-a-readme-for-an-enterprise)"
69+
{%- endif %}

content/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,10 @@ Enterprise owners who create an organization owned by the enterprise account aut
5656
During a trial of {% data variables.product.prodname_ghe_cloud %}, you can create up to three new organizations in your enterprise.
5757

5858
{% data reusables.enterprise-accounts.access-enterprise %}
59-
60-
1. On the **Organizations** tab, above the list of organizations, click **New organization**.
59+
{%- ifversion enterprise-readme %}
60+
1. In the left sidebar, click **Organizations**.
61+
{%- endif %}
62+
1. On the "Organizations" tab, above the list of organizations, click **New organization**.
6163
1. Under "Organization name", type a name for your organization.
6264
1. Click **Create organization**.
6365
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
7274
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.
7375

7476
{% data reusables.enterprise-accounts.access-enterprise %}
75-
1. On the **Organizations** tab, above the list of organizations, click **Invite organization**.
77+
{%- ifversion enterprise-readme %}
78+
{% data reusables.enterprise-accounts.click-organizations-tab %}
79+
{%- endif %}
80+
1. On the "Organizations" tab, above the list of organizations, click **Invite organization**.
7681
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.
7782
1. Click **Invite organization**. The organization owners will receive an email inviting them to join the enterprise.
7883
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
9095
{% endnote %}
9196

9297
{% data reusables.enterprise-accounts.access-enterprise %}
98+
{%- ifversion enterprise-readme %}
99+
{% data reusables.enterprise-accounts.click-organizations-tab %}
100+
{%- endif %}
93101
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**.
94102

95103
{% data reusables.enterprise-accounts.organization-settings-dropdown %}
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: Creating a README for an enterprise
3+
intro: 'You can create a README to tell your members what is happening in your enterprise.'
4+
versions:
5+
feature: enterprise-readme
6+
type: how_to
7+
topics:
8+
- Accounts
9+
- Enterprise
10+
permissions: Enterprise owners can create and edit an enterprise README.
11+
shortTitle: Create a README
12+
---
13+
14+
## About READMEs for enterprises
15+
16+
{% data reusables.enterprise.about-readmes %}
17+
18+
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.
19+
20+
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)."
21+
22+
## Creating a README for an enterprise
23+
24+
{% data reusables.enterprise-accounts.access-enterprise %}
25+
1. On the "Overview" page, click **Create README**. If a README is already present on the page, click **Edit**.
26+
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)."
27+
1. Click **Save**.
28+
29+
## Further reading
30+
31+
- "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)"
32+
- "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme)"

content/admin/managing-your-enterprise-account/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ versions:
55
ghec: '*'
66
children:
77
- /creating-an-enterprise-account
8+
- /creating-a-readme-for-an-enterprise
89
- /deleting-an-enterprise-account
910
- /changing-the-url-for-your-enterprise
1011
shortTitle: Manage enterprise account

content/admin/overview/best-practices-for-enterprises.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,14 @@ We recommend collaborating in organization-owned repositories whenever possible
4747

4848
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)."
4949

50+
{% ifversion enterprise-readme %}
51+
52+
## Create a README
53+
54+
{% data reusables.enterprise.about-readmes %} For more information, see "[AUTOTITLE](/admin/managing-your-enterprise-account/creating-a-readme-for-an-enterprise)."
55+
56+
{% endif %}
57+
5058
## Further reading
5159

5260
- "[AUTOTITLE](/repositories/creating-and-managing-repositories/best-practices-for-repositories)"

content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,11 @@ To create your enterprise account, start a free 30-day trial of {% data variable
3737

3838
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)."
3939

40-
### 4. Viewing the subscription and usage for your enterprise account
40+
### 4. Creating a README for the enterprise
41+
42+
{% data reusables.enterprise.about-readmes %} For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/managing-your-enterprise-account/creating-a-readme-for-an-enterprise)."
43+
44+
### 5. Viewing the subscription and usage for your enterprise account
4145

4246
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)."
4347

content/get-started/onboarding/getting-started-with-github-enterprise-server.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,14 @@ As an enterprise owner or administrator, you can manage settings on user, reposi
8282

8383
{% data reusables.getting-started.enforcing-repo-management-policies %}
8484

85+
{% ifversion enterprise-readme %}
86+
87+
### 7. Creating a README for the enterprise
88+
89+
{% data reusables.enterprise.about-readmes %} For more information, see "[AUTOTITLE](/admin/managing-your-enterprise-account/creating-a-readme-for-an-enterprise)."
90+
91+
{% endif %}
92+
8593
## Part 3: Building securely
8694

8795
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 %}.

content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@ You can choose what information to include in your organization profile README.
4343

4444
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)."
4545

46+
{% ifversion enterprise-readme %}
47+
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)."
48+
{% endif %}
49+
4650
## Adding a public organization profile README
4751

4852
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
102106
{% data reusables.profile.org_settings %}
103107
1. In the "Gravatar email (Private)" field, enter the email address associated with your Gravatar image.
104108
1. Click **Update profile**.
109+
110+
## Further reading
111+
112+
- "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)"
113+
- "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme)"

data/features/enterprise-readme.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Reference: #13661
2+
# Enterprise overview page and README
3+
4+
versions:
5+
ghec: '*'
6+
ghes: '>=3.13'
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
1. In the left sidebar, click **Organizations**.

0 commit comments

Comments
 (0)