Skip to content

Commit 78a772a

Browse files
committed
Fixed review feedback
1 parent d6dd094 commit 78a772a

File tree

8 files changed

+27
-24
lines changed

8 files changed

+27
-24
lines changed

learn-pr/github/authenticate-authorize-user-identities-github/includes/3-authentication.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ You can configure SAML SSO at either the **organization** or **enterprise** leve
1919
- **Enforcement**: Select **Require SAML SSO authentication** to remove non-compliant members automatically.
2020
- **Use Case**: Ideal for phased rollouts or testing with limited impact.
2121

22+
> [!NOTE]
2223
> GitHub removes only organization members who fail to authenticate. Enterprise members remain until they next access the resource.
2324
2425
#### Enterprise-Level SAML SSO
@@ -79,6 +80,7 @@ You can configure SAML SSO at either the **organization** or **enterprise** leve
7980
#### Github SMS support
8081
:::image type="content" source="../media/two-factor-authentication-sms-six-digit-code-example.png" alt-text="Screenshot of the SMS code." :::
8182

83+
> [!NOTE]
8284
> Security keys store credentials locally and never expose secrets. GitHub recommends FIDO2/U2F keys.
8385
8486
### Auditing 2FA Compliance

learn-pr/github/authenticate-authorize-user-identities-github/includes/4-authorization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ Some advantages of using the supported IdPs are:
119119
- Lower setup effort
120120

121121
### Bring Your Own IdP:
122-
Bringing your own IdP requires it isSAML 2.0 support. The advantage of this is that if allows for full flexibility.
122+
Bringing your own IdP requires it isSAML 2.0 support. The advantage of this is that it allows for full flexibility.
123123

124124
### Integration Steps
125125
| Type | Steps |

learn-pr/github/authenticate-authorize-user-identities-github/includes/5-team-synchronization.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,8 @@ Consider the following scenario to understand how team synchronization works in
4747
- Alice is added to the IdP group → automatically added to the GitHub team
4848
- If she leaves the group → automatically removed from the team
4949

50-
**Note:** Team Sync in GHES doesn’t provision accounts. Users must already be GitHub organization members.
50+
> [!NOTE]
51+
> Team Sync in GHES doesn’t provision accounts. Users must already be GitHub organization members.
5152
5253
### Team Sync Configuration
5354

@@ -68,7 +69,8 @@ To disable:
6869

6970
:::image type="content" source="../media/disable-team-synchronization.png" alt-text="Screenshot of the organization setting to disable team synchronization." :::
7071

71-
> Note: Disabling sync removes users from teams if they were added via IdP mapping.
72+
> [!NOTE]
73+
> Disabling sync removes users from teams if they were added via IdP mapping.
7274
7375
### SCIM in GHES
7476
SCIM is an open standard protocol designed to automate the exchange of user identity information between identity domains and IT systems. In the context of GHES, SCIM enables administrators to provision, update, and deprovision user accounts directly through the GitHub API. This means you can create, update, and delete user accounts, and sync group information to map GitHub team memberships.

learn-pr/github/github-administration-for-enterprise-support-adoption/includes/2-github-enterprise-tools-features.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# GitHub Administration for Enterprise Support and Adoption
2-
31
As a GitHub Enterprise administrator, you're responsible for establishing development environments that are both secure and scalable. This unit explores how to distinguish between GitHub Enterprise’s *upkeep* and *automation* features, and how to configure your organization for efficient collaboration.
42

53
We also introduce standards-based developer workflows and rulesets—powerful tools for centralized policy enforcement.
@@ -19,7 +17,7 @@ Imagine your organization has brought in an external contractor team to deliver
1917
- Enabling private GitHub Pages for controlled documentation sharing (an upkeep feature).
2018
- Monitoring GitHub Actions usage to ensure efficient automation across the expanding team (an automation feature).
2119

22-
:::image type="content" source="../media/enterprise-features-dichotomy.png" alt-text="GitHub Enterprise features categories split between Upkeep and Automation":::
20+
:::image type="content" source="../media/enterprise-features-dichotomy.png" alt-text="Diagram of GitHub Enterprise features categories split between Upkeep and Automation.":::
2321

2422

2523
## Establishing Developer Workflow Standards
@@ -43,7 +41,7 @@ To ensure consistency, security, and scalability, GitHub Enterprise organization
4341

4442
**Rulesets** are GitHub's recommended mechanism for enforcing policy at scale. Unlike traditional branch protection rules, rulesets allow you to centrally manage policies across multiple repositories and teams.
4543

46-
:::image type="content" source="../media/ruleset-primary-foucs.png" alt-text="Rulesets overview":::
44+
:::image type="content" source="../media/ruleset-primary-focus.png" alt-text="Screenshot of Rulesets overview.":::
4745

4846
### Benefits of Rulesets
4947

@@ -58,7 +56,7 @@ To ensure consistency, security, and scalability, GitHub Enterprise organization
5856
- Enforce CI/CD checks before merge.
5957
- Restrict access to protected branches.
6058

61-
:::image type="content" source="../media/example-ruleset-policies.png" alt-text="Example ruleset enforcement dashboard":::
59+
:::image type="content" source="../media/example-ruleset-policies.png" alt-text="Screenshot of the ruleset enforcement dashboard.":::
6260

6361
#### Combining Rulesets and Branch Protection (Legacy Support)
6462

@@ -118,10 +116,10 @@ Automation features help reduce human error, enforce coding standards, and strea
118116
#### GitHub Advanced Security (GHAS)
119117

120118
1. Navigate to **Your enterprises > Settings**.
121-
2. Review seat usage under **GitHub Advanced Security**.
119+
2. Review user usage under **GitHub Advanced Security**.
122120
3. If nearing limits, evaluate usage by team and prioritize.
123121

124-
:::image type="content" source="../media/enterprise-licensing-tab-ghas.png" alt-text="GHAS usage dashboard":::
122+
:::image type="content" source="../media/enterprise-licensing-tab-ghas.png" alt-text="Screenshot of GHAS usage dashboard.":::
125123

126124
#### GitHub Actions
127125

@@ -132,7 +130,7 @@ Automation features help reduce human error, enforce coding standards, and strea
132130
- Windows: 2x Linux rate.
133131
- macOS: 10x Linux rate.
134132

135-
:::image type="content" source="../media/actions-minutes.png" alt-text="GitHub Actions minutes usage":::
133+
:::image type="content" source="../media/actions-minutes.png" alt-text="Screenshot of GitHub Actions minutes usage.":::
136134

137135

138136
## CI/CD Strategy in GitHub Enterprise
@@ -150,7 +148,8 @@ GitHub Enterprise enables secure and scalable CI/CD practices using **GitHub Act
150148
- **Security in CI/CD**: Integrate Dependabot, secret scanning, and compliance checks directly into pipelines.
151149
- **Monitoring & Notifications**: Configure alerts and integrate observability tools to track deployment health and performance.
152150

153-
> **Tip**: Define reusable workflows and environments (e.g., staging, production) to ensure consistency and control.
151+
> [!TIP]
152+
> Define reusable workflows and environments (e.g., staging, production) to ensure consistency and control.
154153
155154
### Getting Started
156155

@@ -187,7 +186,7 @@ Administrators can approve, configure, and maintain third-party tools and GitHub
187186
- Monitor permission changes.
188187
- Prefer tools with **Verified Creator** badges for higher trust.
189188

190-
:::image type="content" source="../media/apps-with-verified-publisher-badge-tooltip.png" alt-text="Verified Creator badge in GitHub Marketplace":::
189+
:::image type="content" source="../media/apps-with-verified-publisher-badge-tooltip.png" alt-text="Screenshot of Verified Creator badge in GitHub Marketplace.":::
191190

192191
### Marketplace Guidelines
193192

learn-pr/github/github-administration-for-enterprise-support-adoption/includes/3-support-for-github-enterprise.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
:::image type="content" source="../media/premium-support.png" alt-text="A graphic that shows a stylized support engineer, with icons that represent different times of day":::
22

3-
# GitHub Enterprise Support
4-
53
This unit explains the enhanced support options available with GitHub Enterprise and outlines key responsibilities of administrators when working with GitHub Support. You'll apply this knowledge whether you're using GitHub Enterprise Server (self-hosted) or GitHub Enterprise Cloud (hosted by GitHub).
64

75

@@ -44,7 +42,8 @@ GitHub Support typically assists with issues across three areas: accounts, secur
4442
- Security Incidents: GitHub Support can help mitigate damage from compromised accounts, roll back repository changes, and assist with security recovery.
4543
- Abuse Cases: Support investigates violations of GitHub’s terms, such as harassment or inappropriate content, and can remove users or content as needed.
4644

47-
> ⚠️ Administrators are responsible for infrastructure configuration, CI/CD integrations, third-party auth systems (like SAML), internal scripting, hardware setup, and immediate on-prem issue resolution.
45+
> [!NOTE]
46+
> Administrators are responsible for infrastructure configuration, CI/CD integrations, third-party auth systems (like SAML), internal scripting, hardware setup, and immediate on-prem issue resolution.
4847
4948

5049

@@ -58,7 +57,7 @@ Include the following:
5857
- Context (e.g., first occurrence, frequency, business impact)
5958
- Error messages (verbatim)
6059

61-
### 🔥 GitHub Support Priority Levels
60+
### GitHub Support Priority Levels
6261

6362
| Priority | Description | Typical Response Time |
6463
|----------|-------------|------------------------|

learn-pr/github/github-administration-for-enterprise-support-adoption/includes/4-scale-your-github-enterprise-deployment.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
# GitHub Enterprise: Scalable Administration and Governance
2-
31
As your GitHub Enterprise organization grows—whether due to team expansion or new contractor engagements—administrators are responsible for ensuring secure access, managing identity lifecycles, monitoring compliance, and optimizing deployment pipelines. This unit introduces key GitHub Enterprise features and governance tools to help you scale securely and efficiently.
42

53

64
## Secure Access with Single Sign-On (SSO)
75

8-
To maintain centralized identity control and streamline user management, enable SAML-based single sign-on (SSO) with your identity provider (IdP), such as Okta or Microsoft Entra ID.
6+
To maintain centralized identity control and streamline user management, enable SAML-based Single Sign-On (SSO) with your identity provider (IdP), such as Okta or Microsoft Entra ID.
97

10-
> **Tip:** From your organization’s **People** tab, you can review and revoke individual SAML credentials under the **SAML identity linked** section.
8+
> [!TIP]
9+
> From your organization’s **People** tab, you can review and revoke individual SAML credentials under the **SAML identity linked** section.
1110
12-
> **Important:** If you use team synchronization, revoking a user’s SSO identity automatically removes them from any teams mapped to IdP groups.
11+
> [!IMPORTANT]
12+
> If you use team synchronization, revoking a user’s SSO identity automatically removes them from any teams mapped to IdP groups.
1313
1414

1515
## Automate Identity Management with SCIM and APIs
@@ -72,7 +72,7 @@ GraphQL enables you to fetch only the data you need or mutate enterprise setting
7272

7373
Enterprise Apps enhance oversight and control over GitHub Apps installed across your organizations.
7474

75-
### Setup Overview:
75+
### Setup Overview
7676

7777
| Platform | Steps |
7878
|----------|-------|
@@ -101,7 +101,8 @@ The [GitHub Marketplace](https://github.com/marketplace) offers reusable automat
101101
| **Auth Model** | Uses temporary `GITHUB_TOKEN` | Uses JWT + installation token |
102102
| **Billing** | Billed per Action minute | SaaS-based (subscription/licensing) |
103103

104-
> **Tip:** Use GitHub Actions for ephemeral, event-based automation. Choose GitHub Apps when building persistent services with deeper API interactions or advanced permission scopes.
104+
> [!TIP]
105+
> Use GitHub Actions for ephemeral, event-based automation. Choose GitHub Apps when building persistent services with deeper API interactions or advanced permission scopes.
105106
106107

107108
### How Marketplace Tools Work Under the Hood
618 KB
Loading

0 commit comments

Comments
 (0)