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

Please update help document on using a PAT for git #3975

Closed
plastikfan opened this issue Feb 24, 2021 · 5 comments
Closed

Please update help document on using a PAT for git #3975

plastikfan opened this issue Feb 24, 2021 · 5 comments
Labels
triage Do not begin working on this issue until triaged by the team

Comments

@plastikfan
Copy link

What article on docs.github.com is affected?

https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token#using-a-token-on-the-command-line

What part(s) of the article would you like to see updated?

Please see the ticket I raised about this:

https://support.github.com/ticket/personal/0/1033425

Additional information

@welcome
Copy link

welcome bot commented Feb 24, 2021

Thanks for opening this issue. 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 Feb 24, 2021
@janiceilene
Copy link
Contributor

👋 @plastikfan Thanks so much for opening an issue! Since folks in this open source repo don't have access to see your support ticket, could you describe what it is you'd like to see updated in the docs? Thank you!

@plastikfan
Copy link
Author

plastikfan commented Mar 1, 2021

Sorry I made the assumption that you could see the ticket, because I can. Ive copied the text for you to see the issue:

Please can you update this article for essential required information regarding use of a personal access token to authenticate to git over https Creating a personal access token.

Having created a new PAT, I had no idea what to do with it as this article doesnt explain. I found an equivalent article for using an ssh key and in that article you do say that to use the newly generated ssh key, you use ssh-add. We need equivalent information for PAT on https, for windows, linux and mac).

This page currently assumes you don't already have the repo checked out. This is just one scenario and therfore doesn't cover all bases (or at least the majority of)


So to be clear, what is https/PAT equivalent of this page:

https://docs.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent

In that page there is a section that says how to add an ssh key to the ssh agent.

We need the same for https/PAT.

You also need to explain the Windows Credential manager (and equivalent on mac/linux). If the user is not currently being prompted for credentials, it because the credential manager has this already cached and the user needs to know what to do with the credntial manager in order to be re-prompted.

@janiceilene
Copy link
Contributor

Thanks for the clarification @plastikfan! If you've got a suggestion that will work for all Windows users out of the box, you're welcome to open a pull request to make the fix. Thank you!

@plastikfan
Copy link
Author

plastikfan commented Mar 3, 2021

@janiceilene, I havent got the time to do a pull request. I searched for an official windows explanation of the windows credential manager, but the officiall link I found in MS documents was really quite deficient. I better explanation would be soemthime like:

https://www.digitalcitizen.life/credential-manager-where-windows-stores-passwords-other-login-details/

(The microsoft link I found: https://support.microsoft.com/en-us/windows/accessing-credential-manager-1b5c916a-6a16-889f-8581-fc16e8165ac0, really doesnt say very much).

I'm sure theres enough information in either of these links for you to update the github docs)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
triage Do not begin working on this issue until triaged by the team
Projects
None yet
Development

No branches or pull requests

4 participants
@janiceilene @plastikfan and others