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
Clarify "PAT" in the userinfo subcomponent when authenticating to repos. #31718
Comments
@ObjectOops Thanks for opening this issue! I'll get this triaged for review ✨ |
This comment was marked as spam.
This comment was marked as spam.
@ObjectOops - Thank you for raising this. It would be good to clarify this in https://docs.github.com/en/codespaces/troubleshooting/troubleshooting-authentication-to-a-repository, as per the details you've given above. I've marked this issue Information about contributing to the docs: Markdown file here: https://github.com/github/docs/blob/main/content/codespaces/troubleshooting/troubleshooting-authentication-to-a-repository.md?plain=1 |
Code of Conduct
What article on docs.github.com is affected?
https://docs.github.com/en/codespaces/troubleshooting/troubleshooting-authentication-to-a-repository
What part(s) of the article would you like to see updated?
The purpose of the string "PAT" in the username field when using this method of authentication isn't very clear.
It may be assumed that the username field must be set as "PAT", when it can actually take any value as long as it doesn't malform the URL.
There could also be confusion as to where the access token should be inserted.
Replacing "PAT" with a less ambiguous value like "USERNAME" may be more appropriate.
Additional information
The text was updated successfully, but these errors were encountered: