Skip to content

Commit cf456ec

Browse files
committed
Update intro to admin
1 parent 9a6c405 commit cf456ec

16 files changed

+106
-108
lines changed

github/github-introduction-administration/1-introduction.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Introduction
44
metadata:
55
title: Introduction
66
description: An introduction to the topics you'll learn about in this module.
7-
ms.date: 8/23/2021
7+
ms.date: 2/16/2023
88
author: lucie-docs
99
ms.author: lucielenaour
1010
ms.topic: interactive-tutorial

github/github-introduction-administration/2-what-is-github-administration.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: What is GitHub administration?
44
metadata:
55
title: What is GitHub administration?
66
description: Overview of common GitHub administration tasks and hierarchical levels.
7-
ms.date: 8/23/2021
7+
ms.date: 2/16/2023
88
author: lucie-docs
99
ms.author: lucielenaour
1010
ms.topic: interactive-tutorial

github/github-introduction-administration/3-how-github-authentication-works.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: How does GitHub authentication work?
44
metadata:
55
title: How does GitHub authentication work?
66
description: Discover the ways in which administrators can configure GitHub authentication.
7-
ms.date: 8/23/2021
7+
ms.date: 2/16/2023
88
author: lucie-docs
99
ms.author: lucielenaour
1010
ms.topic: interactive-tutorial

github/github-introduction-administration/4-how-github-organization-permission-works.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: How does GitHub organization and permissions work?
44
metadata:
55
title: How does GitHub organization and permissions work?
66
description: Deep dive into the hierarchical structure of GitHub's permission levels.
7-
ms.date: 8/23/2021
7+
ms.date: 2/16/2023
88
author: lucie-docs
99
ms.author: lucielenaour
1010
ms.topic: interactive-tutorial

github/github-introduction-administration/5-knowledge-check.yml

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Knowledge check
44
metadata:
55
title: Check your knowledge
66
description: Review what you've learned.
7-
ms.date: 8/23/2021
7+
ms.date: 2/16/2023
88
author: lucie-docs
99
ms.author: lucielenaour
1010
ms.topic: interactive-tutorial
@@ -13,45 +13,45 @@ durationInMinutes: 3
1313
quiz:
1414
title: Check your knowledge
1515
questions:
16-
- content: "You want to grant a user the permissions required to add and remove organization members to a team. Which permission would you need to grant that user?"
16+
- content: "You want to grant a user the permissions required to add and remove organization members to and from a team. Which permission would you need to grant that user?"
1717
choices:
1818
- content: "The admin permission on a repository"
1919
isCorrect: false
20-
explanation: "The admin permission on a repository will only allow you to perform full administration-related tasks on a specific repository; it will not affect membership on a team."
20+
explanation: "Incorrect. The admin permission on a repository only allows you to perform full administration-related tasks on a specific repository; it doesn't affect membership on a team."
2121
- content: "The maintain permission on a repository"
2222
isCorrect: false
23-
explanation: "The maintain permission on a repository will only allow you to perform limited administration-related tasks on a specific repository; it will not affect membership on a team."
23+
explanation: "Incorrect. The maintain permission on a repository only allows you to perform limited administration-related tasks on a specific repository; it doesn't affect membership on a team."
2424
- content: "Organization billing manager"
2525
isCorrect: false
26-
explanation: "The organization billing manager permission only allows the user to handle billing related tasks; it will not affect membership on a team."
26+
explanation: "Incorrect. The organization billing manager permission only allows the user to handle billing related tasks; it doesn't affect membership on a team."
2727
- content: "Team maintainer"
2828
isCorrect: true
29-
explanation: "As a team maintainer, the user will be able to add and remove organization members to a team."
30-
- content: "As an organization owner, you want to ensure that everyone who is signed in to your corporate network can access the GitHub website without requiring a second sign-in. Which technology will you enable to accomplish this?"
29+
explanation: "Correct! As a team maintainer, the user can add and remove organization members to and from a team."
30+
- content: "As an organization owner, you want to ensure that everyone who is signed in to your corporate network can access the GitHub website without requiring a second sign-in. Which technology would you enable to accomplish this?"
3131
choices:
32-
- content: "Single Sign-On"
32+
- content: "Single sign-on"
3333
isCorrect: true
34-
explanation: "Single Sign-On is the right technology to allow network users to access the GitHub website without additional sign-ins."
34+
explanation: "Correct! Single sign-on is the right technology to allow network users to access the GitHub website without extra sign-ins."
3535
- content: "Two-factor authentication"
3636
isCorrect: false
37-
explanation: "Two-factor authentication would require each user to sign in using a second means of identifying themselves, like using an authenticator app on their phones. It would not be used in this scenario."
38-
- content: "SSH Keys"
39-
isCorrect: false
40-
explanation: "Personal Access Tokens provide access for the git client or web API by using a cryptographic key. You do not use them to access the GitHub website."
37+
explanation: "Incorrect. Two-factor authentication requires each user to sign in by using a second means of identifying themselves, like using an authenticator app on their phones."
4138
- content: "Personal Access Tokens"
4239
isCorrect: false
43-
explanation: "Personal Access Tokens provide access for the git client through a username and password. You do not use them to access the GitHub website."
44-
- content: "What is the appropriate repository permission level for contributors who will actively push changes to your repository?"
40+
explanation: "Incorrect. Personal Access Tokens provide access for the git client or web API by using a cryptographic key. You don't use them to access the GitHub website."
41+
- content: "SSH keys"
42+
isCorrect: false
43+
explanation: "Incorrect. SSH keys provide access for the git client through a username and password. You don't use them to access the GitHub website."
44+
- content: "What's the appropriate repository permission level for contributors who need to actively push changes to your repository?"
4545
choices:
4646
- content: "admin"
4747
isCorrect: false
48-
explanation: "The admin permission is not appropriate because provides too much access to the administration functions of the repository."
48+
explanation: "Incorrect. The admin permission isn't appropriate because it provides too much access to the administration functions of the repository."
4949
- content: "write"
5050
isCorrect: true
51-
explanation: "The write permission is the appropriate permission level."
51+
explanation: "Correct! The write permission is the appropriate permission level."
5252
- content: "triage"
5353
isCorrect: false
54-
explanation: "The triage permission is not appropriate because it is intended for contributors who need to proactively manage issues and pull requests without write access."
54+
explanation: "Incorrect. The triage permission is for contributors who need to proactively manage issues and pull requests without making changes."
5555
- content: "maintain"
5656
isCorrect: false
57-
explanation: "The maintain permission is not appropriate because it is intended for project managers who need to manage the repository without access to sensitive or destructive actions. It would provide too much access for other users."
57+
explanation: "Incorrect. The maintain permission is for contributors who need to manage the repository without access to sensitive or destructive actions. It provides too much access for other users."

github/github-introduction-administration/6-summary.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Summary
44
metadata:
55
title: Summary
66
description: A recap on what you learned about GitHub administration in this module.
7-
ms.date: 8/23/2021
7+
ms.date: 2/16/2023
88
author: lucie-docs
99
ms.author: lucielenaour
1010
ms.topic: interactive-tutorial
Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,19 @@
1-
GitHub administrators work to ensure that their organization's code and content assets are protected while providing each team access to the repositories they rely on to collaborate and share their work.
1+
GitHub administrators work to protect their organization's code and content assets while providing each team access to the repositories they rely on to collaborate and share their work.
22

3-
Imagine that your CIO asks you for an adoption plan to help the entire company benefit from GitHub. You want to ensure every group has adequate access to the right repositories and that there is a sustainable way to provide adequate permissions to the appropriate software development and content teams. You will need to think through the kinds of tasks that administrators need to perform and assign them the right level of access. But first, you really need to understand what options are available to you from GitHub.
3+
Imagine that your CIO asks you for an adoption plan to help the entire company benefit from GitHub. You want to ensure every group has adequate access to the right repositories and that there's a sustainable way to provide adequate permissions to the appropriate software development and content teams. You'll need to think through the kinds of tasks that administrators need to perform and assign them the right level of access. But first, you really need to understand what options are available to you from GitHub.
44

5-
In this module, you will learn about:
5+
In this module, you'll learn about:
66

77
- GitHub administrative tasks and their purpose at each hierarchical level.
88
- The various ways that administrators can configure authentication so that users can access GitHub via the web browser and the git client.
99
- Hierarchical permission levels and what these permissions allow you to do in GitHub.
1010

1111
## Learning objectives
1212

13-
By the end of this module, you will be able to:
13+
By the end of this module, you'll be able to:
1414

1515
- Summarize the organizational structures and permission levels that GitHub administrators can use to organize members to control access and security.
1616
- Identify the various technologies that enable a secure authentication strategy, allowing administrators to centrally manage repository access.
17-
- Describe the technologies required to centrally manage teams and members using existing directory information services and how GitHub can itself be used as an identity provider for authentication and authorization.
17+
- Describe the technologies required to centrally manage teams and members using existing directory information services and how you can use GitHub itself as an identity provider for authentication and authorization.
1818

19-
## Prerequisites
20-
21-
- Familiarity with GitHub, repositories, and the basics of managing individual accounts
22-
- Familiarity with personal and organizational authentication technologies and processes
2319

github/github-introduction-administration/includes/2-what-is-github-administration.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,41 @@ As a GitHub administrator, your goal is to keep everything working smoothly for
22

33
## Administration at team level
44

5-
:::image type="content" source="../media/teams.png" alt-text="Screenshot of organization screen with Teams tab highlighted.":::
5+
:::image type="content" source="../media/teams.png" alt-text="Screenshot of the organization screen with the Teams tab highlighted.":::
66

7-
In GitHub, each user is an organization member that can be added to a team. You can create teams in your organization with cascading access permissions and mentions to reflect your company or group's structure. Teams are useful for refining repository permissions on a more granular level and enabling communication and notification between team members.
7+
In GitHub, each user is an organization member that you can add to a team. You can create teams in your organization with cascading access permissions and mentions to reflect your company or group's structure. Teams are useful for refining repository permissions on a more granular level and enabling communication and notification between team members.
88

9-
Additionally, GitHub allows you to sync your teams with identity provider (IdP) groups such as Azure Active Directory (Azure AD). When you synchronize a GitHub team with an Azure AD, changes to the Azure AD group are automatically reflected on GitHub, reducing the need for manual updates and custom scripts. You can use an Azure AD with team synchronization to manage administrative tasks such as onboarding new members, granting new permissions for movements within an organization, and removing member access from the organization.
9+
Additionally, GitHub allows you to sync your teams with identity provider (IdP) groups such as Azure Active Directory (Azure AD). When you synchronize a GitHub team with Azure AD, you can replicate changes to GitHub automatically, which reduces the need for manual updates and custom scripts. You can use Azure AD with team synchronization to manage administrative tasks such as onboarding new members, granting new permissions, and removing member access to the organization.
1010

1111
Members of a team with *team maintainer* or repository *admin* permissions can:
1212

13-
- Create a new team, as well as select or change the parent team.
13+
- Create a new team, and select or change the parent team.
1414
- Delete or rename a team.
1515
- Add or remove organization members from a team, or synchronize a GitHub team's membership with an IdP group.
16-
- Add or remove outside collaborators (people who are not explicitly members of your organization, such as consultants or temporary employees) from team repositories.
17-
- Enable or disable team discussions, where the team can plan together, update one another, or talk about any topic in discussion posts on the organization's team's page.
16+
- Add or remove outside collaborators (people who aren't explicitly members of your organization, such as consultants or temporary employees) from team repositories.
17+
- Enable or disable team discussions on the team's page.
1818
- Change the visibility of the team within the organization.
1919
- Manage automatic code review assignment for pull requests, utilizing GitHub's review assignment routing algorithm.
20+
- Schedule reminders.
21+
- Set the team profile picture.
2022

2123
### Best practices for team-level administration
2224

2325
Creating teams in your organization enables greater flexibility for collaboration and can make it easier to separate repositories and permissions. The following are some best practices for setting up teams on GitHub:
2426

2527
- Create nested teams to reflect your group or company's hierarchy within your GitHub organization.
2628
- Create teams based on interests or specific technology (JavaScript, data science, etc.) to help streamline PR review processes. Individuals can choose to join these teams according to their interests or skills.
27-
- Enable team synchronization between your identity provider (IdP) and GitHub to allow organization owners and team maintainers to connect teams in your organization with IdP groups. When you synchronize a GitHub team with an IdP group, changes to the IdP group are reflected on GitHub automatically, reducing the need for manual updates and custom scripts. You can use an IdP with team synchronization to manage administrative tasks such as onboarding new members, granting new permissions for movements within an organization, and removing member access to the organization.
29+
- Enable team synchronization between your identity provider (IdP) and GitHub to allow organization owners and team maintainers to connect teams in your organization with IdP groups. When you synchronize a GitHub team with an IdP group, you can replicate changes to GitHub automatically, reducing the need for manual updates and custom scripts. You can use an IdP with team synchronization to manage administrative tasks such as onboarding new members, granting new permissions, and removing member access to the organization.
2830

2931
## Administration at organization level
3032

3133
In GitHub, organizations are shared spaces enabling users to collaborate across many projects at once. Owners and administrators can manage member access to the organization's data and repositories with sophisticated security and administrative features.
3234

3335
Members of an organization with the *owner* permission can perform a wide range of activities at the organization level including:
3436

35-
- Invite users to join the organization, as well as remove members from the organization.
37+
- Invite users to join the organization and remove members from the organization.
3638
- Organize users into a team, and grant "team maintainer" permissions to organization members.
37-
- Add or remove outside collaborators (people who are not explicitly members of your organization, such as consultants or temporary employees) to organizational repositories.
39+
- Add or remove outside collaborators (people who aren't explicitly members of your organization, such as consultants or temporary employees) to organizational repositories.
3840
- Grant repository permission levels to members, and set the base (default) permission level for a given repository.
3941
- Set up organization security.
4042
- Set up billing or assign a billing manager for the organization.
@@ -43,14 +45,12 @@ Members of an organization with the *owner* permission can perform a wide range
4345

4446
We recommend setting up only one organization for your users and repositories. If specific constraints in your company require you to create multiple organizations, be aware that:
4547

46-
- It is not possible to duplicate an organization or share configurations between two organizations. This means that you must set up everything from scratch every time you create an organization, which increases the risk of errors in your settings.
48+
- It isn't possible to duplicate an organization or share configurations between two organizations. This means that you must set up everything from scratch every time you create an organization, which increases the risk of errors in your settings.
4749
- Depending on your software providers' policies, you might incur extra costs if you need to install some applications in multiple organizations.
4850
- Managing multiple organizations is generally more difficult!
4951

5052
## Administration at enterprise level
5153

52-
:::image type="content" source="../media/avocado-corp.png" alt-text="Screenshot of enterprise screen.":::
53-
5454
Enterprise accounts include GitHub Enterprise Cloud and Enterprise Server instances and enable owners to centrally manage policy and billing for multiple organizations.
5555

5656
At the enterprise level, members of an enterprise with the *owner* permissions can:
@@ -64,6 +64,5 @@ At the enterprise level, members of an enterprise with the *owner* permissions c
6464

6565
## Learn more
6666

67-
This link provides more information about the topics covered in this module:
67+
Read more about [nested teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams#nested-teams)in GitHub Docs.
6868

69-
[GitHub documentation on nested teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams#nested-teams)

0 commit comments

Comments
 (0)