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

Clarify "PAT" in the userinfo subcomponent when authenticating to repos. #31718

Closed
1 task done
ObjectOops opened this issue Feb 18, 2024 · 3 comments · Fixed by #32796
Closed
1 task done

Clarify "PAT" in the userinfo subcomponent when authenticating to repos. #31718

ObjectOops opened this issue Feb 18, 2024 · 3 comments · Fixed by #32796
Labels
Codespaces Content relating to GitHub Codespaces content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue

Comments

@ObjectOops
Copy link
Contributor

ObjectOops commented Feb 18, 2024

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.

You can clone the repository with a URL that includes the access token. Replace YOUR-VARIABLE with the name of the environment variable or secret you created.
git clone https://PAT:[email protected]/OWNER/REPO

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

@ObjectOops ObjectOops added the content This issue or pull request belongs to the Docs Content team label Feb 18, 2024
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Feb 18, 2024
@nguyenalex836 nguyenalex836 added Codespaces Content relating to GitHub Codespaces 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 Feb 19, 2024
@nguyenalex836
Copy link
Contributor

@ObjectOops Thanks for opening this issue! I'll get this triaged for review ✨

@gsosm0760

This comment was marked as spam.

@hubwriter hubwriter added help wanted Anyone is welcome to open a pull request to fix this issue and removed waiting for review Issue/PR is waiting for a writer's review labels Mar 7, 2024
@docs-bot docs-bot added this to Help wanted in Docs open source board Mar 7, 2024
@hubwriter
Copy link
Contributor

hubwriter commented Mar 7, 2024

@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 help-wanted. If you (or anyone else reading this) would like to raise a pull request to update the docs accordingly that would be great.

Information about contributing to the docs:
https://docs.github.com/en/contributing

Markdown file here: https://github.com/github/docs/blob/main/content/codespaces/troubleshooting/troubleshooting-authentication-to-a-repository.md?plain=1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Codespaces Content relating to GitHub Codespaces content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue
Development

Successfully merging a pull request may close this issue.

5 participants
@hubwriter @ObjectOops @nguyenalex836 @gsosm0760 and others