search

github / docs

The open-source repo for docs.github.com
https://docs.github.com
Creative Commons Attribution 4.0 International
16.15k stars 59.36k forks source link

Clarify use of OAuth credential helpers in local Git installation #34710

Open JDLH opened 4 days ago

JDLH commented 4 days ago

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/get-started/getting-started-with-git/caching-your-github-credentials-in-git

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

Instead of telling readers to "install and use GitHub CLI" or "install and use Git Credential Manager" with no explanation of authentication, instead also mention the option of other Git credential helpers. And, mention that OAuth authentication is happening behind the scenes. Add a tip about the need for organization approval of OAuth apps not pre-approved by GitHub.

This is based on my difficulties understanding how to get OAuth authentication from my local Git installation. The current content does not mention OAuth, or the need for organisation approval of OAuth apps not pre-approved by GitHub. Both those omissions caused obstacles for me.

Additional information

I have a pull request with suggested improvements all ready to go: #34712 .

[Edited to add PR number.]

welcome[bot] commented 4 days ago

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.

nguyenalex836 commented 3 days ago

@JDLH Thank you for opening an issue and linking it to your PR! ✨

AdityaSrivastava185 commented 1 day ago

@JDLH I would like to contribute to the issue byt before contributing to it ,i would like to ask that you want to include the clear explanation of the OAuth and OAuth in local git installations ?

JDLH commented 1 day ago

@AdityaSrivastava185 , thank you for the offer. My inclination is to separate the changes. Let this one get included, then make a second change to improve it even more. If we tie them together, they may get bogged down and neither will get accepted.

But there is no harm in planning ahead. Assume that my PR #34712 gets accepted. What specific changes would you suggest for it? If you would you like me to suggest better wording, then what is not clear to you about the wording in #34712?

AdityaSrivastava185 commented 1 day ago

I understand @JDLH , I can't suggest anything specific before seeing your changes but make sure to add all the details which could be little bit confusing for the beginners such as including use cases and troubleshooting tips because , i have found this common things either missing or not clear in the documentations I hope it will help you Thank you

JDLH commented 1 day ago

I can't suggest anything specific before seeing your changes

You can see my proposed changes in pull request #34712 . See especially the links in the Content directory changes section. e.g. the preview of the page reads with my changes compared to the current page.

Does that help?

AdityaSrivastava185 commented 1 day ago

Yes , it's helpful 🙂