diff --git a/docs/connected-accounts.rst b/docs/connected-accounts.rst index c25d6dbf76f..4ac43024cfa 100644 --- a/docs/connected-accounts.rst +++ b/docs/connected-accounts.rst @@ -13,8 +13,7 @@ Connecting your account allows for: If you signed up or logged in to Read the Docs with your GitHub, Bitbucket, or GitLab credentials, you're all done. Your account is connected. -To connect your unconnected account, go to your *Settings* dashboard -and select `Connected Services `_. +To connect a social account, go to your :guilabel:`Username dropdown` > :guilabel:`Settings` > :guilabel:`Connected Services`. From here, you'll be able to connect to your GitHub, Bitbucket or GitLab account. This process will ask you to authorize a connection to Read the Docs, that allows us to read information about and clone your repositories. @@ -66,6 +65,38 @@ Repository status (``repo:status``) but there isn't a more granular permission that only allows setting up SSH keys for read access. +.. _github-permission-troubleshooting: + +GitHub permission troubleshooting +````````````````````````````````` + +**Repositories not in your list to import**. + +Many organizations require approval for each OAuth application that is used, +or you might have disabled it in the past for your personal account. +This can happen at the personal or organization level, +depending on where the project you are trying to access has permissions from. + +.. tabs:: + + .. tab:: Personal Account + + You need to make sure that you have granted access to the Read the Docs `OAuth App`_ to your **personal GitHub account**. + If you do not see Read the Docs in the `OAuth App`_ settings, you might need to disconnect and reconnect the GitHub service. + + .. seealso:: GitHub docs on `requesting access to your personal OAuth`_ for step-by-step instructions. + + .. _OAuth App: https://github.com/settings/applications + .. _requesting access to your personal OAuth: https://docs.github.com/en/organizations/restricting-access-to-your-organizations-data/approving-oauth-apps-for-your-organization + + .. tab:: Organization Account + + You need to make sure that you have granted access to the Read the Docs OAuth App to your **organization GitHub account**. + If you don't see "Read the Docs" listed, then you might need to connect GitHub to your social accounts as noted above. + + .. seealso:: GitHub doc on `requesting access to your organization OAuth`_ for step-by-step instructions. + + .. _requesting access to your organization OAuth: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/requesting-organization-approval-for-oauth-apps Bitbucket ~~~~~~~~~ diff --git a/docs/pull-requests.rst b/docs/pull-requests.rst index b9798e26cbb..c72d0c59f45 100644 --- a/docs/pull-requests.rst +++ b/docs/pull-requests.rst @@ -59,17 +59,15 @@ Troubleshooting #. **Pull Requests builds are not triggered**. We only support GitHub and GitLab currently. You need to make sure that your Read the Docs account is connected with that provider. - You can check this by going to your `profile settings`_. + You can check this by going to your :guilabel:`Username dropdown` > :guilabel:`Settings` > :guilabel:`Connected Services`. #. **Build status is not being reported to your VCS provider**. You need to make sure that you have granted access to the Read the Docs - `OAuth App`_ to your personal or organization GitHub account. - If you do not see "Read the Docs" in the `OAuth App`_ settings, - you might need to disconnect and reconnect to GitHub service. + OAuth App to your personal or organization GitHub account. + Learn more about this in our :ref:`github-permission-troubleshooting` section. Also make sure your webhook is properly setup to handle events related to pull requests. You can setup or ``re-sync`` the webhook from your projects admin dashboard. Learn more about setting up webhooks from our :doc:`Webhook Documentation `. -.. _profile settings: https://readthedocs.org/accounts/social/connections/ .. _OAuth App: https://github.com/settings/applications