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 use of OAuth credential helpers in local Git installation #34710

Open
1 task done
JDLH opened this issue Sep 24, 2024 · 7 comments
Open
1 task done

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

JDLH opened this issue Sep 24, 2024 · 7 comments
Labels
content This issue or pull request belongs to the Docs Content team get started Content related to "Getting Started" doc set

Comments

@JDLH
Copy link

JDLH commented Sep 24, 2024

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.]

@JDLH JDLH added the content This issue or pull request belongs to the Docs Content team label Sep 24, 2024
Copy link

welcome bot commented Sep 24, 2024

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 Sep 24, 2024
@nguyenalex836 nguyenalex836 added waiting for review Issue/PR is waiting for a writer's review needs SME This proposal needs review from a subject matter expert get started Content related to "Getting Started" doc set and removed triage Do not begin working on this issue until triaged by the team labels Sep 24, 2024
@github github deleted a comment from github-actions bot Sep 24, 2024
@nguyenalex836 nguyenalex836 removed needs SME This proposal needs review from a subject matter expert waiting for review Issue/PR is waiting for a writer's review labels Sep 24, 2024
@nguyenalex836
Copy link
Contributor

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

@AdityaSrivastava185
Copy link

@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
Copy link
Author

JDLH commented Sep 26, 2024

@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
Copy link

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
Copy link
Author

JDLH commented Sep 26, 2024

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
Copy link

Yes , it's helpful 🙂

@github github deleted a comment from victorinojeffrey Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team get started Content related to "Getting Started" doc set
Projects
None yet
4 participants
@JDLH @AdityaSrivastava185 @nguyenalex836 and others