-
Notifications
You must be signed in to change notification settings - Fork 803
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
small updates to auth docs #515
Conversation
doc/source/authentication.rst
Outdated
|
||
.. note:: | ||
|
||
The org_whitelist is optional and will require users to accept the read:org github oath scope when logging in. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo in oath
thanks for noticing @manics !! |
doc/source/authentication.rst
Outdated
@@ -52,7 +52,8 @@ Below is the structure to use in order to authenticate with GitHub. | |||
|
|||
.. note:: | |||
|
|||
The org_whitelist is optional and will require users to accept the read:org github oath scope when logging in. | |||
The org_whitelist is optional and will require users to accept the read:org github OAuth scope when | |||
logging in. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps a note here that it is not required if all the users membership is public
great point @cam72cam ! |
That does not exactly address my concern, perhaps something like: The |
@cam72cam hmm - I'm actually a bit unclear as to what |
@choldgraf I've got a related PR open: #523 |
Let's leave this open and you're welcome to suggest language here that I can add once you merge it in! That work for you? |
(just please remember to ping me when it's merged) |
@choldgraf read:org means that the application can lookup what organizations the user is a member of (both public and private memberships) |
@choldgraf Suggested text in choldgraf#1 |
Explain auth.github.org_whitelist
Makes GitHub first (since it's the easiest+most free of the auth steps) and adds a bit of extra information