Skip to content
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

Add docs about setting up permissions for GH apps & orgs #8305

Merged
merged 7 commits into from
Jul 6, 2021

Conversation

ericholscher
Copy link
Member

@ericholscher ericholscher commented Jun 30, 2021

This is a common issue,
so now we at least have a link to point users to.

Closes #7381

This is a common issue,
so now we at least have a link to point users to.
@ericholscher ericholscher requested a review from a team June 30, 2021 23:33
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.

👍 this is one of our more common support requests.

docs/connected-accounts.rst Outdated Show resolved Hide resolved
docs/connected-accounts.rst Outdated Show resolved Hide resolved
docs/connected-accounts.rst Outdated Show resolved Hide resolved
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.
Copy link
Contributor

Choose a reason for hiding this comment

The 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.

Copy link
Member Author

Choose a reason for hiding this comment

The 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.

Copy link
Contributor

@astrojuanlu astrojuanlu left a comment

Choose a reason for hiding this comment

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

Looks good. I have needed something like this in the past, and I still do sometimes...

@@ -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`.
Copy link
Member

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.

Copy link
Member Author

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..

@@ -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:
Copy link
Member

Choose a reason for hiding this comment

The 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?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think I added this prior to adding the section label.

docs/connected-accounts.rst Outdated Show resolved Hide resolved
docs/pull-requests.rst Outdated Show resolved Hide resolved
docs/connected-accounts.rst Outdated Show resolved Hide resolved
ericholscher and others added 2 commits July 6, 2021 14:23
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
@ericholscher ericholscher enabled auto-merge (squash) July 6, 2021 21:24
@ericholscher ericholscher merged commit 93d1d65 into master Jul 6, 2021
@ericholscher ericholscher deleted the github-auth branch July 6, 2021 21:31
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.

Organization not showing up in repository list
5 participants