Remove reference to Basic Authentication in the docs #2555
Conversation
Edited the section on Authentication to remove Basic Auth, which GitHub no longer supports, with instructions for using a Personal Access Token.
|
Fixes #2554 |
|
Hey Chris,
I've only ever used Git Hub for my personal projects. This was the first PR I have ever done to a public project. Is there something further I need to do to get this moved to the main branch?
Thanks,
Randy
…----------------------------------------
From: "Chris Simpson" ***@***.***>
Sent: 8/25/22 11:42 PM
To: "octokit/octokit.net" ***@***.***>
Cc: Randy Kreisel ***@***.***>, Author ***@***.***>
Subject: Re: [octokit/octokit.net] Update getting-started.md (PR #2555)
@JonruAlveus approved this pull request.
Thanks for the contribution! ⭐
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you authored the thread.
|
Hi Randy, Firstly, thanks for the contribution! Around merging the PR, after the one change I think we're good to go. Once that's done I or one of the other Contributers can merge the PR. I believe our primary merger is currently on holiday 😄 |
Second commit: Removed "/en" from links.
docs/getting-started.md
Outdated
|
|
||
| ### Authenticated Access | ||
|
|
||
| If you want to access private repositories or perform actions on behalf of a user, you need to pass credentials to the client. | ||
|
|
||
| There are two options supported by the API - basic and OAuth authentication. | ||
| There are two Authentication options supported by the API. |
There was a problem hiding this comment.
This isn't quite true. But that's not your fault, as GitHub's authentication options are very very complicated 🙈 I think I would correct this and just say something like this:
| There are two Authentication options supported by the API. | |
| You can authenticate by passing an access token, for example a personal access token (PAT), an OAuth access token or an installation token from a GitHub App |
There was a problem hiding this comment.
(As well as accepting this suggestion, you would need to remove the bullet pointed list below it.)
Co-authored-by: Tim Rogers <timrogers@github.com>
Co-authored-by: Tim Rogers <timrogers@github.com>
Removed the two bullet pointed items because the sentence preceding them provided a clearer description of the options.
timrogers
changed the title
timrogers
changed the title
|
release_notes: Removed reference to Basic Authentication in the docs |
nickfloyd
added
Type: Documentation
Edited the section on Authentication to remove Basic Auth, which GitHub no longer supports, with instructions for using a Personal Access Token.