diff --git a/docs/connected-accounts.rst b/docs/connected-accounts.rst index 3db7ed6ca51..3a913b46e42 100644 --- a/docs/connected-accounts.rst +++ b/docs/connected-accounts.rst @@ -1,5 +1,5 @@ Connecting Your Account ------------------------ +======================= If you are going to import repositories from GitHub, Bitbucket, or GitLab, you should connect your Read the Docs account to your repository host first. @@ -18,3 +18,69 @@ and select `Connected Services ` + asks for one additional permission (``repo``) to allow access to private repositories + and to allow us to setup SSH keys to clone your private repositories. + Unfortunately, this is the permission for read/write control of the repository + but there isn't a more granular permission + that only allows setting up SSH keys for read access. + + +Bitbucket +~~~~~~~~~ + +For similar reasons to those above for GitHub, we request permissions for: + +* Reading your account information including your email address +* Read access to your team memberships +* Read access to your repositories +* Read and write access to webhooks + +GitLab +~~~~~~ + +Like the others, we request permissions for: + +* Reading your account information (``read_user``) +* API access (``api``) which is needed to create webhooks in GitLab