-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Add docs about setting up permissions for GH apps & orgs #8305
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
Changes from 5 commits
682225c
887935c
8c518fe
c6c7700
b3baa7a
52c98d5
f554e5d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 <https://readthedocs.org/accounts/social/connections/>`_. | ||
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: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We are using autolabel, there is no need for this, at least I'm missing something? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think I added this prior to adding the section label. |
||
|
||
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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It might be helpful to discuss the outcome to the user here as well. The question I always field is "why are my repositories not in my list of repositories I can import" or "why is my organization missing from the import page". I'd like to link to this section in the dashboard UI later, so hopefully can help direct users at the source. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Aye -- I don't know the best way to structure it, so I just put it in bold for now. |
||
|
||
.. 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 |com_brand| listed, then you might need to connect GitHub in your social accounts as noted above. | ||
ericholscher marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
.. 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 | ||
~~~~~~~~~ | ||
|
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.
I think we should still mention the link, something like "go to this link or ...". It is easier to just click than search for the UI elements.
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.
We need a way to link to both sites, if we're providing a link..