Skip to content

Document connected account permissions #6172

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

Merged
merged 2 commits into from
Sep 26, 2019

Conversation

davidfischer
Copy link
Contributor

This is a documentation only pull request that just documents why we ask for the permissions from GitHub, Bitbucket, and GitLab. We've had a few questions about this in the past.

There is a meta question of whether this is the right place for this information. Another question is whether we should link to this from the login and signup screens so users are prepared for permission prompts.

@davidfischer davidfischer requested a review from a team September 12, 2019 02:42
@saadmk11
Copy link
Member

Should we talk about the GitLab Event we are accessing (e.g: merge_requests_events) ?

# Optional
'issues_events': False,
'merge_requests_events': True,
'note_events': False,
'job_events': False,
'pipeline_events': False,
'wiki_events': False,

@stsewd
Copy link
Member

stsewd commented Sep 12, 2019

@saadmk11 webhooks are part of the API. That is only the list of events we subscribe when creating the webhook (that list of events are in this same page if I remember correctly).

Copy link
Member

@stsewd stsewd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a meta question of whether this is the right place for this information.

I think it is 👍

we should link to this from the login and signup screens so users are prepared for permission prompts.

I think this is a good idea. We should put this on https://readthedocs.org/accounts/social/connections/ too.

@davidfischer
Copy link
Contributor Author

If we're good with this change, let's go forward with it. Once this has "been released" an is available in the stable version, we'll add those links to it.

Copy link
Contributor

@agjohnson agjohnson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's good to have this explicitly stated, there have been questions here in the past. Mostly from commercial accounts wondering why we require admin repo permissions. Hopefully the move to a GitHub App, instead of the OAuth app, will give us more permission granularity and we can avoid asking for admin access.

However, we do need permissions for authorizing your account
so that you can login to Read the Docs with your connected account credentials
and to setup :doc:`webhooks`
which allow us to build your documentation on every change to your repository.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately, the commercial side does ask for admin (and therefore write) permissions, as this is the lowest granularity that GitHub has/had in order to add private ssh keys. Moving to a GitHub App instead does probably give us finer permission control, if i remember correctly.

@agjohnson agjohnson merged commit 6905051 into master Sep 26, 2019
@agjohnson agjohnson deleted the davidfischer/connected-account-perms branch September 26, 2019 22:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants