Skip to content

Commit 2048104

Browse files
[Now] Create concepts category for enterprise admin docs (#57847)
Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com>
1 parent 1623e9b commit 2048104

File tree

21 files changed

+129
-59
lines changed

21 files changed

+129
-59
lines changed

content/admin/overview/best-practices-for-enterprises.md renamed to content/admin/concepts/best-practices-for-enterprises.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,13 @@ intro: 'Learn {% data variables.product.company_short %}-recommended practices f
55
versions:
66
ghec: '*'
77
ghes: '*'
8-
type: overview
8+
contentType: concepts
99
topics:
1010
- Accounts
1111
- Enterprise
1212
- Fundamentals
13+
redirect_from:
14+
- /admin/overview/best-practices-for-enterprises
1315
---
1416

1517
{% ifversion ghec %}
@@ -62,5 +64,4 @@ Organizations can have more than one organization owner to avoid lapses in owner
6264

6365
## Further reading
6466

65-
* [AUTOTITLE](/repositories/creating-and-managing-repositories/best-practices-for-repositories)
6667
* [AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/best-practices-for-organizations)

content/admin/managing-your-enterprise-account/about-enterprise-accounts.md renamed to content/admin/concepts/enterprise-fundamentals/enterprise-accounts.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: About enterprise accounts
3-
intro: Learn how enterprise accounts enable scalability by simplifying administration and billing across multiple organizations.
2+
title: Enterprise accounts
3+
intro: 'Learn how enterprise accounts enable scalability by simplifying administration and billing across multiple organizations.'
44
redirect_from:
55
- /articles/about-github-business-accounts
66
- /articles/about-enterprise-accounts
@@ -10,10 +10,11 @@ redirect_from:
1010
- /github/setting-up-and-managing-your-enterprise/about-enterprise-accounts
1111
- /github/setting-up-and-managing-your-enterprise/managing-your-enterprise-account/about-enterprise-accounts
1212
- /admin/overview/about-enterprise-accounts
13+
- /admin/managing-your-enterprise-account/about-enterprise-accounts
1314
versions:
1415
ghec: '*'
1516
ghes: '*'
16-
type: overview
17+
contentType: concepts
1718
topics:
1819
- Accounts
1920
- Enterprise
@@ -52,7 +53,7 @@ Administrators for the enterprise account can:
5253

5354
## What if I use multiple deployment options?
5455

55-
If you use both {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %}, you'll have an enterprise account for each.
56+
If you use both {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %}, you'll have **an enterprise account for each.**
5657

5758
For the most part, you will manage each enterprise account separately. For example, you will configure the policies and settings for your {% data variables.product.prodname_ghe_server %} instance using the enterprise account on {% data variables.product.prodname_ghe_server %}.
5859

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Enterprise fundamentals
3+
shortTitle: Fundamentals
4+
intro: 'Learn the fundamental concepts that you''ll need to understand {% data variables.location.product_location %}, including fundamentals, identity and access management, security and compliance, and best practices.'
5+
versions:
6+
ghes: '*'
7+
ghec: '*'
8+
topics:
9+
- Enterprise
10+
children:
11+
- /enterprise-accounts
12+
- /teams-in-an-enterprise
13+
- /roles-in-an-enterprise
14+
contentType: concepts
15+
---

content/admin/overview/about-roles.md renamed to content/admin/concepts/enterprise-fundamentals/roles-in-an-enterprise.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
11
---
2-
title: About roles in an enterprise
2+
title: Roles in an enterprise
33
intro: 'Learn how roles allow you to control people''s access to your enterprise''s settings and resources.'
44
versions:
55
ghec: '*'
66
ghes: '*'
7-
shortTitle: About roles
8-
type: overview
7+
shortTitle: Roles
98
topics:
109
- Enterprise
1110
- Fundamentals
11+
redirect_from:
12+
- /admin/overview/about-roles
13+
contentType: concepts
1214
---
1315

1416
## What are roles?
1517

16-
A role is a set of permissions that you can assign to individuals or teams. A permission is the ability to perform a specific action, such as changing billing settings.
18+
A role is a **set of permissions** that you can assign to individuals or teams. A permission is the ability to perform a specific action, such as changing billing settings.
1719

1820
A user in an enterprise has a role for both the enterprise account itself and for each individual organization in the enterprise.
1921

@@ -35,7 +37,7 @@ Enterprise roles are assigned when a user is invited to the enterprise (personal
3537

3638
Organization administrators can grant organization roles and create custom organization roles, but can't affect roles at the enterprise level.
3739

38-
## Next steps
40+
## Further reading
3941

4042
Review the predefined roles and fine-grained permissions available with custom organization roles, and plan out what roles will be required for your teams to do their jobs on {% data variables.product.github %}.
4143

content/admin/overview/about-teams.md renamed to content/admin/concepts/enterprise-fundamentals/teams-in-an-enterprise.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
---
2-
title: About teams in an enterprise
2+
title: Teams in an enterprise
33
intro: 'Learn how teams simplify administration of user access, licensing, and communication.'
44
versions:
55
ghec: '*'
6-
shortTitle: About teams
7-
type: overview
6+
shortTitle: Teams
87
topics:
98
- Enterprise
109
- Fundamentals
10+
redirect_from:
11+
- /admin/overview/about-teams
12+
contentType: concepts
1113
---
1214

1315
## What are teams?
@@ -54,3 +56,7 @@ Unlike organization teams, enterprise teams currently do **not** support:
5456
In addition, enterprise teams are currently limited to 50 teams for a single enterprise and 500 users to each team.
5557

5658
For more information about the capabilities of organization teams, see [AUTOTITLE](/organizations/organizing-members-into-teams/about-teams).
59+
60+
## Further reading
61+
62+
* [AUTOTITLE](/organizations/organizing-members-into-teams/about-teams)
Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: 'About {% data variables.product.prodname_emus %}'
3-
shortTitle: About managed users
2+
title: About {% data variables.product.prodname_emus %}
3+
shortTitle: Enterprise Managed Users
44
intro: 'Learn how your enterprise can manage the lifecycle and authentication of users on {% data variables.product.prodname_dotcom %} from your identity provider (IdP).'
55
redirect_from:
66
- /early-access/github/articles/get-started-with-managed-users-for-your-enterprise
@@ -16,9 +16,10 @@ redirect_from:
1616
- /admin/identity-and-access-management/using-enterprise-managed-users-for-iam
1717
- /admin/identity-and-access-management/managing-iam-for-your-enterprise/about-enterprise-managed-users
1818
- /admin/identity-and-access-management/understanding-iam-for-enterprises/about-enterprise-managed-users
19+
- /admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users
1920
versions:
2021
ghec: '*'
21-
type: overview
22+
contentType: concepts
2223
topics:
2324
- Accounts
2425
- Authentication
@@ -27,7 +28,9 @@ topics:
2728
allowTitleToDifferFromFilename: true
2829
---
2930

30-
With {% data variables.product.prodname_emus %}, you manage the lifecycle and authentication of your users on {% data variables.product.prodname_dotcom_the_website %} or {% data variables.enterprise.data_residency_site %} from an external identity management system, or IdP:
31+
## What are Enterprise Managed Users in {% data variables.product.github %}?
32+
33+
With {% data variables.product.prodname_emus %}, you manage the lifecycle and authentication of your users on {% data variables.product.prodname_dotcom_the_website %} or {% data variables.enterprise.data_residency_site %} **from an external identity management system, or IdP**:
3134

3235
* Your IdP **provisions new user accounts** on {% data variables.product.prodname_dotcom %}, with access to your enterprise.
3336
* Users must **authenticate on your IdP** to access your enterprise's resources on {% data variables.product.prodname_dotcom %}.
@@ -37,11 +40,11 @@ With {% data variables.product.prodname_emus %}, you manage the lifecycle and au
3740

3841
> [!NOTE] {% data variables.product.prodname_emus %} is not the best solution for every customer. To determine whether it's right for your enterprise, see [AUTOTITLE](/admin/identity-and-access-management/understanding-iam-for-enterprises/choosing-an-enterprise-type-for-github-enterprise-cloud).
3942
40-
## Identity management systems
43+
## How does EMUs integrate with identity management systems?
4144

4245
{% data reusables.enterprise_user_management.emu-paved-path-iam-integrations %}
4346

44-
### Partner identity providers
47+
### What are partner identity providers?
4548

4649
Partner IdPs provide authentication using SAML or OIDC, and provide provisioning with System for Cross-domain Identity Management (SCIM).
4750

@@ -57,7 +60,7 @@ Partner IdPs provide authentication using SAML or OIDC, and provide provisioning
5760

5861
When you use a single partner IdP for both authentication and provisioning, {% data variables.product.company_short %} provides support for the application on the partner IdP and the IdP's integration with {% data variables.product.prodname_dotcom %}.
5962

60-
### Other identity management systems
63+
### Can I use identity management systems other than the supported partners?
6164

6265
If you cannot use a single partner IdP for both authentication and provisioning, you can use another identity management system or combination of systems. The system must:
6366

@@ -67,7 +70,7 @@ If you cannot use a single partner IdP for both authentication and provisioning,
6770

6871
{% data reusables.emus.mixed-systems-note %}
6972

70-
## Usernames and profile information
73+
## How are usernames and profile information managed for EMUs?
7174

7275
{% data variables.product.prodname_dotcom %} automatically creates a username for each developer by normalizing an identifier provided by your IdP. If the unique parts of the identifier are removed during normalization, a conflict may occur. See [AUTOTITLE](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication#resolving-username-problems).
7376

@@ -76,13 +79,13 @@ The profile name and email address of a {% data variables.enterprise.prodname_ma
7679
* The IdP can only provide one email address.
7780
* Changing a user's email address in your IdP will unlink the user from the contribution history associated with the old email address.
7881

79-
## Managing roles and access
82+
## How are roles and access managed for EMUs?
8083

8184
In your IdP, you can give each {% data variables.enterprise.prodname_managed_user %} a **role in your enterprise**, such as member, owner, or guest collaborator. See [AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise).
8285

8386
Organization memberships (and repository access) can be managed manually, or you can **update memberships automatically using IdP groups**. See [AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/managing-team-memberships-with-identity-provider-groups).
8487

85-
## Authentication for {% data variables.enterprise.prodname_managed_users %}
88+
## How do {% data variables.enterprise.prodname_managed_users %} authenticate to {% data variables.product.prodname_dotcom %}?
8689

8790
The locations where {% data variables.enterprise.prodname_managed_users %} can authenticate to {% data variables.product.prodname_dotcom %} depends on how you configure authentication (SAML or OIDC). See [AUTOTITLE](/authentication/authenticating-with-single-sign-on/authenticating-with-a-managed-user-account).
8891

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
---
2-
title: About identity and access management
3-
shortTitle: About IAM
2+
title: Identity and access management fundamentals
3+
shortTitle: Fundamentals
44
intro: 'Administrators must decide how users will access the enterprise''s resources on {% data variables.product.github %}.'
55
versions:
66
ghec: '*'
77
ghes: '*'
8-
type: overview
8+
contentType: concepts
99
redirect_from:
1010
- /admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise
1111
- /admin/identity-and-access-management/managing-iam-for-your-enterprise/about-identity-and-access-management
1212
- /admin/identity-and-access-management/understanding-iam-for-enterprises/about-identity-and-access-management
13+
- /admin/managing-iam/understanding-iam-for-enterprises/about-identity-and-access-management
1314
topics:
1415
- Accounts
1516
- Authentication
@@ -18,7 +19,7 @@ topics:
1819
- SSO
1920
---
2021

21-
## About IAM for {% data variables.product.github %}
22+
## What is IAM for {% data variables.product.github %}?
2223

2324
{% ifversion ghec %}
2425

@@ -32,7 +33,7 @@ Administrators who configure a {% data variables.product.prodname_ghe_server %}
3233

3334
{% endif %}
3435

35-
## Authentication methods
36+
## Which authentication method are available to me?
3637

3738
{% ifversion ghec %}
3839

@@ -81,7 +82,7 @@ If you choose to use external authentication, you can also configure fallback au
8182

8283
{% endif %}
8384

84-
## About provisioning
85+
## How does provisioning work?
8586

8687
{% ifversion ghec %}
8788

@@ -97,17 +98,15 @@ If you configure built-in authentication, CAS, LDAP, or SAML, {% data variables.
9798

9899
{% ifversion emu-public-scim-schema %}
99100

100-
## About supported IdPs
101+
## Which IdPs are supported?
101102

102103
{% data reusables.enterprise_user_management.ghec-supported-idps %}
103104

104105
{% endif %}
105106

106107
## Further reading
107108

108-
* [AUTOTITLE](/get-started/learning-about-github/types-of-github-accounts)
109109
* [AUTOTITLE](/admin/overview/about-enterprise-accounts)
110110
{%- ifversion ghec %}
111111
* [AUTOTITLE](/organizations/managing-membership-in-your-organization/can-i-create-accounts-for-people-in-my-organization)
112-
* [AUTOTITLE](/admin/identity-and-access-management/using-saml-for-enterprise-iam/switching-your-saml-configuration-from-an-organization-to-an-enterprise-account)
113112
{%- endif %}
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: Identity and access management
3+
shortTitle: Identity and access management
4+
intro: 'Learn the concepts around identity and access management (IAM) for {% data variables.location.product_location %}, including authentication, authorization, {% ifversion ghec %}Enterprise Managed Users, {% endif %}and user management.'
5+
versions:
6+
ghes: '*'
7+
ghec: '*'
8+
topics:
9+
- Enterprise
10+
children:
11+
- /identity-and-access-management-fundamentals
12+
- /enterprise-managed-users
13+
contentType: concepts
14+
---

content/admin/concepts/index.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Concepts for enterprises
3+
shortTitle: Concepts
4+
intro: 'Learn the core concepts that you''ll need to understand {% data variables.location.product_location %}.'
5+
versions:
6+
ghes: '*'
7+
ghec: '*'
8+
topics:
9+
- Enterprise
10+
children:
11+
- /enterprise-fundamentals
12+
- /identity-and-access-management
13+
- /security-and-compliance
14+
- /best-practices-for-enterprises
15+
contentType: concepts
16+
---
Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: About the audit log for your enterprise
2+
title: Audit log for an enterprise
33
intro: 'To support debugging and internal and external compliance, {% data variables.product.github %} provides logs of audited{% ifversion ghes %} system,{% endif %} user, organization, and repository events.'
4-
shortTitle: About audit logs
4+
shortTitle: Audit logs
55
redirect_from:
66
- /enterprise/admin/articles/audit-logging
77
- /enterprise/admin/installation/audit-logging
@@ -11,18 +11,19 @@ redirect_from:
1111
- /github/setting-up-and-managing-your-enterprise/managing-your-enterprise-users-with-your-identity-provider/auditing-activity-in-your-enterprise
1212
- /admin/authentication/managing-your-enterprise-users-with-your-identity-provider/auditing-activity-in-your-enterprise
1313
- /admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/auditing-activity-in-your-enterprise
14+
- /admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise
1415
versions:
1516
ghes: '*'
1617
ghec: '*'
17-
type: overview
18+
contentType: concepts
1819
topics:
1920
- Auditing
2021
- Enterprise
2122
- Logging
2223
- Security
2324
---
2425

25-
## About audit logs
26+
## What are audit logs?
2627

2728
> [!NOTE]
2829
> {% data reusables.webhooks.webhooks-as-audit-log-alternative %}
@@ -38,7 +39,7 @@ topics:
3839

3940
In addition to viewing your audit log, you can monitor activity in your enterprise in other ways, such as {% ifversion ghes %}viewing push logs and {% endif %}managing global webhooks. For more information, see [AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/exploring-user-activity). You can also use the audit log, and other tools, to monitor the actions taken in response to security alerts. For more information, see [AUTOTITLE](/code-security/getting-started/auditing-security-alerts).
4041

41-
## Using your audit logs
42+
## How to use audit logs
4243

4344
As an enterprise owner{% ifversion ghes %} or site administrator{% endif %}, you can interact with the audit log data for your enterprise in several ways:
4445
* You can view the audit log for your enterprise. For more information, see [AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise).

0 commit comments

Comments
 (0)