docs icon indicating copy to clipboard operation
docs copied to clipboard

adding note about team sync

Open sukoonmusic opened this issue 3 years ago â€ĸ 3 comments

👋đŸŊ

Why:

While working through these instructions and setting up our Okta instance with GitHub, we found that the IdP group assignment option does not appear for teams that have a child team assigned. here is a screenshot of the option that is not available for parent teams:

image

What's being changed (if available, include any code snippets, screenshots, or gifs):

Adding a quick note to make users aware of this requirement.

Check off the following:

  • [x] I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • [x] For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • [ ] This pull request impacts the contribution experience
    • [ ] I have added the 'writer impact' label
    • [ ] I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

sukoonmusic avatar Aug 10 '22 17:08 sukoonmusic

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar Aug 10 '22 17:08 welcome[bot]

Automatically generated comment â„šī¸

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md ghec
ghae
ghec
ghae

fpt: Free, Pro, Team ghec: GitHub Enterprise Cloud ghes: GitHub Enterprise Server ghae: GitHub AE

github-actions[bot] avatar Aug 10 '22 17:08 github-actions[bot]

@sukoonmusic Thanks so much for opening a PR! I'll get this triaged for review :zap:

cmwilson21 avatar Aug 11 '22 13:08 cmwilson21

Thanks @sukoonmusic, and nice to see a familiar face! 😊 I'm just going to confirm with the team that this is expected behavior and will review your PR after I hear back from them. 🙇đŸģâ€â™€ī¸

lecoursen avatar Aug 16 '22 15:08 lecoursen

Whoops... I actually just realized we already document this limitation earlier in the article:

Parent teams cannot synchronize with IdP groups. If the team you want to connect to an IdP group is a parent team, we recommend creating a new team or removing the nested relationships that make your team a parent team. For more information, see "About teams," "Creating a team," and "Moving a team in your organization's hierarchy."

Do you think that information would have been more discoverable for you if we had a dedicated section about requirements and limitations for groups? It could also include these Iines from the article:

You can connect up to five IdP groups to a GitHub Enterprise Cloud team. You can assign an IdP group to multiple GitHub Enterprise Cloud teams.

Team synchronization does not support IdP groups with more than 5000 members.

If so, feel free to update your PR accordingly! Otherwise feel free to close. 😊

lecoursen avatar Aug 16 '22 15:08 lecoursen

👋đŸŊ hey @lecoursen! whoa, I definitely missed it. Thank you for pointing me to it 🙏đŸŊ

Will go ahead and close, and remember to read closer next time!!

sukoonmusic avatar Aug 16 '22 18:08 sukoonmusic