Skip to content

Updating the documentation for Configuring SAML & SCIM in OKTA to include steps for adding the GHEC - Org app integration. #22476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Dec 8, 2022

Conversation

adamrr724
Copy link
Contributor

@adamrr724 adamrr724 commented Dec 5, 2022

Why:

Closes : #22475

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

I have added steps to the "Configuring SAML single sign-on and SCIM using Okta" page to include the steps for adding the app integration necessary to set up SAML on OKTA using GitHub. This includes a reusable widget for searching for and adding the correct app integration and includes one screenshot.

Check off the following:

  • 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).
  • For content changes, I have completed the self-review checklist.

@welcome
Copy link

welcome bot commented Dec 5, 2022

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.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Dec 5, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Dec 5, 2022

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/managing-saml-single-sign-on-for-your-organization/configuring-saml-single-sign-on-and-scim-using-okta.md ghec
ghec

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

@adamrr724
Copy link
Contributor Author

@stacycarter Hey! I put this docs contribution together to try to make these docs a bit clearer when setting up SAML for an Org in OKTA. Would you mind reviewing the changes I made? You can see them here: https://docs-22476-d70dcc.preview.ghdocs.com/en/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/configuring-saml-single-sign-on-and-scim-using-okta

@cmwilson21
Copy link
Contributor

👋 @adamrr724 Thanks for submitting a PR! I edited your post slightly to link it to your issue ✨

I'll get this triaged for review! ⚡

@cmwilson21 cmwilson21 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review organizations Content related to organizations and removed triage Do not begin working on this issue until triaged by the team labels Dec 6, 2022
Copy link
Member

@lecoursen lecoursen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @adamrr724! I'm going to apply some suggestions to better follow our style guide and content models. Then, I need you to save your new images in the repository, please... I've updated the image references to include the directory and file names you should use. After you've done that, let me know, and I'll do another review. 😊

lecoursen and others added 4 commits December 7, 2022 09:04
Part of the reason these docs needed to be updated was to make these titles/steps more specific. Oauth App Integration in OKTA ≠ GitHub Oauth App, and specifying that this is being set up for SAML -- specifically for a GHEC organization (and not for an enterprise) -- is very important in providing clarity.
@adamrr724
Copy link
Contributor Author

Adding my description from the most recent commit to add context as to why those titles should remain more specific:

Part of the reason these docs needed to be updated was to make these titles/steps more specific. Oauth App Integration in OKTA ≠ GitHub Oauth App, and specifying that this is being set up for SAML -- specifically for a GHEC organization (and not for an enterprise) -- is very important in providing clarity.

@lecoursen
Copy link
Member

Part of the reason these docs needed to be updated was to make these titles/steps more specific. Oauth App Integration in OKTA ≠ GitHub Oauth App

Thanks for that clarification!

and specifying that this is being set up for SAML -- specifically for a GHEC organization (and not for an enterprise) -- is very important in providing clarity.

I agree, but that is true for the entire article, so we should be establishing that in the article title and overall conceptual content for the whole article, not individual section headings. I agree we could do a better job of that (probably because SAML only existed at the organization level when this article was originally created/named), but that's beyond the scope of this update. Could you please open an issue in github/docs-internal to track those additional changes internally? Thanks!

lecoursen
lecoursen previously approved these changes Dec 8, 2022
@lecoursen lecoursen enabled auto-merge December 8, 2022 16:56
@lecoursen lecoursen merged commit f8fb8be into github:main Dec 8, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Dec 8, 2022

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

Copy link

@mahn4889 mahn4889 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am with you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team organizations Content related to organizations waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

About SAML and SCIM in OKTA page doesn't include clear instructions on enabling/setting up the OKTA GHEC -Org app integration.
4 participants