GitHub App: open beta #12217
GitHub App: open beta #12217
Conversation
| - `Read the Docs Community <https://github.com/apps/read-the-docs-community/installations/new/>`__ | ||
| - `Read the Docs Business <https://github.com/apps/read-the-docs-business/installations/new/>`__ | ||
|
|
||
| Once you have installed the GitHub App, click on the :guilabel:`Projects` tab, and click on :guilabel:`Add project`, |
There was a problem hiding this comment.
This feels pretty clunky :/ I definitely know we're going to get support on this, and we should make sure we're including this information in the dashboard as well:
Don't see your project listed here? Make sure it's included in the <a>GitHub application</a>
There was a problem hiding this comment.
We already have this message, wasn't sure where to put that other message related to the GH app...
Maybe having the two is fine?
There was a problem hiding this comment.
There was a problem hiding this comment.
It's not really clear to me what we're trying to solve here, or at least what the aim is on UX.
Is the user expected to have to update their GHA permissions every time they create a project from a new repository?
If so, and this is going to be consistently the case, then we should probably have some better UI for GitHub App users specifically. Basically a more prominent or mandatory block than the "Can't find the repository" block at the bottom, and something explicit and closer to what Eric mentioned above.
If this isn't a standard case, the button at the botton is okay but I'd replace the "Referesh your repositories" button instead of having two buttons for GHA users. Having two buttons is going to result in users clicking both repeatedly trying to figure out which one and which order helps.
There was a problem hiding this comment.
The buttons solve different issues, one suggest the user to install the app into the repository they want to install, this action needs to be done from GH, the other button resyncs our DB with the repositories the use has access to. When the GH app users shouldn't need to refresh, but it could still be needed.
There was a problem hiding this comment.
Is the user expected to have to update their GHA permissions every time they create a project from a new repository?
This depends on how the user grants access to repositories to the app, if they select individual projects, then it's needed, if they marked "select all", then there is no need, as GH will install the app on every repository when created.
There was a problem hiding this comment.
This depends on how the user grants access to repositories to the app,
But not future repositories, correct? We might be somewhere in the middle then, it's going to be common enough that users will get tripped up here but not common enough to make this mandatory, visually.
The buttons solve different issues
I get they have different functions, but my concern is probably more that GHA users shouldn't need to refresh repositories. They definitely shouldn't have to click refresh after clicking to update our GHA permissions. But I thought refresh would be less common with GHA as we have repository create/update events through the webhook now. It's okay if we're not there yet though.
Can follow up more in readthedocs/ext-theme#606 I don't think the docs will change with that PR.
| - `Read the Docs Community <https://github.com/apps/read-the-docs-community/installations/new/>`__ | ||
| - `Read the Docs Business <https://github.com/apps/read-the-docs-business/installations/new/>`__ | ||
|
|
||
| Once you have installed the GitHub App, click on the :guilabel:`Projects` tab, and click on :guilabel:`Add project`, |
There was a problem hiding this comment.
It's not really clear to me what we're trying to solve here, or at least what the aim is on UX.
Is the user expected to have to update their GHA permissions every time they create a project from a new repository?
If so, and this is going to be consistently the case, then we should probably have some better UI for GitHub App users specifically. Basically a more prominent or mandatory block than the "Can't find the repository" block at the bottom, and something explicit and closer to what Eric mentioned above.
If this isn't a standard case, the button at the botton is okay but I'd replace the "Referesh your repositories" button instead of having two buttons for GHA users. Having two buttons is going to result in users clicking both repeatedly trying to figure out which one and which order helps.
Co-authored-by: Anthony <aj@ohess.org>
|
This PR seems ready to be merged. There are some ongoing discussions still, but they have their own PRs and/or issues. If there is anything else we need to adapt here, we can do it as we go. Once this code is deployed and users start using this feature, I'm sure we will need to do some quick hotfixes as we find issues. It's not gonna be perfect initially since this work is huge. |
Uh oh!
There was an error while loading. Please reload this page.