Skip to content
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

Fixes GHES docs for PAT as SSO not available #33695

Merged
merged 13 commits into from
Jul 19, 2024
Merged

Conversation

amarvin
Copy link
Contributor

@amarvin amarvin commented Jun 25, 2024

Why:

GitHub Enterprise Server (GHES) allows generating personal access tokens (PATs), but unlike GitHub Cloud or GitHub Enterprise Cloud (GHEC) there is no option in GHES to enable SAML SSO for PATs.

Closes: #33696

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

  • Adds a screenshot from GHES that doesn't show PAT with "configure SSO"
  • Updates PAT docs to use new screenshot for GHES

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

Copy link

welcome bot commented Jun 25, 2024

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 Jun 25, 2024
Copy link
Contributor

github-actions bot commented Jun 25, 2024

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
authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md fpt
ghec
ghes@ 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.13 3.12 3.11 3.10

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

@amarvin amarvin marked this pull request as ready for review June 25, 2024 14:53
@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team authentication Content relating to authentication waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Jun 25, 2024
@nguyenalex836
Copy link
Contributor

@amarvin Thanks so much for opening a PR! I'll get this triaged for review ✨

@amarvin
Copy link
Contributor Author

amarvin commented Jun 25, 2024

Thanks, @nguyenalex836!

luddyinthehouse

This comment was marked as spam.

@stevecat stevecat self-requested a review July 8, 2024 13:21
@stevecat
Copy link
Member

stevecat commented Jul 8, 2024

Hi @amarvin, thanks for working on this, it looks like a really good change!

Before we merge this, can I ask you to make one tiny change? Our style guide asks us not to include liquid conditionals in filenames, this can cause problems for a few automations we have.

It won't look as neat but could you change this so we have two complete image tags? For example:

{% ifversion ghes %}![Screenshot of the "{% data variables.product.pat_generic_caps_plural %}" page. Next to a blurred-out token, an icon of two overlapping squares is outlined in orange.](/assets/images/help/settings/personal-access-tokens-ghes.png){% else %}![Screenshot of the "{% data variables.product.pat_generic_caps_plural %}" page. Next to a blurred-out token, an icon of two overlapping squares is outlined in orange.](/assets/images/help/settings/personal-access-tokens.png){% endif %}

Let me know once you've made the change so I can review and get this merged! ✨

@nguyenalex836 nguyenalex836 added more-information-needed More information is needed to complete review and removed waiting for review Issue/PR is waiting for a writer's review labels Jul 9, 2024
@amarvin
Copy link
Contributor Author

amarvin commented Jul 9, 2024

Hi @amarvin, thanks for working on this, it looks like a really good change!

Before we merge this, can I ask you to make one tiny change? Our style guide asks us not to include liquid conditionals in filenames, this can cause problems for a few automations we have.

It won't look as neat but could you change this so we have two complete image tags? For example:

{% ifversion ghes %}![Screenshot of the "{% data variables.product.pat_generic_caps_plural %}" page. Next to a blurred-out token, an icon of two overlapping squares is outlined in orange.](/assets/images/help/settings/personal-access-tokens-ghes.png){% else %}![Screenshot of the "{% data variables.product.pat_generic_caps_plural %}" page. Next to a blurred-out token, an icon of two overlapping squares is outlined in orange.](/assets/images/help/settings/personal-access-tokens.png){% endif %}

Let me know once you've made the change so I can review and get this merged! ✨

Great point and sorry for missing that in the style guide! I've made the change for you to review.

@amarvin
Copy link
Contributor Author

amarvin commented Jul 12, 2024

@stevecat, this is ready for your review.

@amarvin
Copy link
Contributor Author

amarvin commented Jul 19, 2024

nudge @stevecat

@nguyenalex836
Copy link
Contributor

@amarvin Hello! 👋 Thank you very much for your patience - it looks like @stevecat might not be available for a little while. The changes you made as requested look great! I'll go ahead and get this merged 💛 Thank you again for your patience!

@nguyenalex836 nguyenalex836 added this pull request to the merge queue Jul 19, 2024
Merged via the queue into github:main with commit 950bfbe Jul 19, 2024
45 checks passed
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
authentication Content relating to authentication content This issue or pull request belongs to the Docs Content team more-information-needed More information is needed to complete review
4 participants