Skip to content

Commit 716fdcf

Browse files
authored
Clarify GitHub App instructions (#12634)
This is a bit overly explicit, but I think users keep getting confused, so I think overly explicit is good. ------ [Codex Task](https://chatgpt.com/codex/tasks/task_e_6931a971b3d483208d671ee51163624c)
1 parent fd3bcfd commit 716fdcf

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

docs/user/reference/git-integration.rst

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -305,11 +305,13 @@ Adding a project from a repository
305305

306306
To add a project from a repository,
307307
you need to install the Read the Docs GitHub App and grant access to that repository.
308+
Use the links below to complete the installation and permissions,
309+
then create the project from your **Read the Docs account**.
308310

309311
- `Read the Docs Community <https://github.com/apps/read-the-docs-community/installations/new/>`__
310312
- `Read the Docs Business <https://github.com/apps/read-the-docs-business/installations/new/>`__
311313

312-
Once you have installed the GitHub App, click on the :guilabel:`Projects` tab, and click on :guilabel:`Add project`,
314+
Once you have installed the GitHub App, in Read the Docs, click on the :guilabel:`Projects` tab, and click on :guilabel:`Add project`,
313315
search for the repository you want to create a project for, and then follow the instructions from there.
314316

315317
Connect a repository to an existing project
@@ -318,11 +320,13 @@ Connect a repository to an existing project
318320
In case you manually added a project on Read the Docs,
319321
or if you want to connect your project to a different repository,
320322
you need to install the Read the Docs GitHub App and grant access to the repository you want to connect.
323+
As with adding a project, complete installation and permissions via the links below,
324+
and select the repository from your **project settings on Read the Docs**.
321325

322326
- `Read the Docs Community <https://github.com/apps/read-the-docs-community/installations/new/>`__
323327
- `Read the Docs Business <https://github.com/apps/read-the-docs-business/installations/new/>`__
324328

325-
Once you have installed the GitHub App, go the :guilabel:`Settings` page of the project,
329+
Once you have installed the GitHub App, go to the :guilabel:`Settings` page of the project in Read the Docs,
326330
and select the repository you want to connect from the :guilabel:`Connected repository` dropdown.
327331

328332
Manually migrating a project
@@ -337,16 +341,16 @@ But in case you need to manually migrate a project,
337341
you can follow these steps:
338342

339343
- Go to the :guilabel:`Settings` page of your Read the Docs project,
340-
and click on :guilabel:`Integrations`, and delete all the integrations that are listed there.
344+
and click on the :guilabel:`Integrations` tab in Read the Docs, and delete all the integrations that are listed there.
341345
- Go to the settings page of your GitHub repository,
342-
click on :guilabel:`Webhooks`, and delete all the webhooks with URLs that start with:
346+
click on the GitHub :guilabel:`Webhooks` tab, and delete all the webhooks with URLs that start with:
343347

344348
- ``https://readthedocs.org/api/v2/webhook/<your-project-slug>`` or ``https://app.readthedocs.org/api/v2/webhook/<your-project-slug>`` for Read the Docs Community.
345349
- ``https://readthedocs.com/api/v2/webhook/<your-project-slug>`` or ``https://app.readthedocs.com/api/v2/webhook/<your-project-slug>`` for Read the Docs Business.
346350

347351
- For projects using Read the Docs Business,
348352
go to the settings page of your GitHub repository,
349-
click on :guilabel:`Deploy keys`, and delete the deploy with a title matching the format ``[email protected] (<your-project-slug>)``.
353+
click on the GitHub :guilabel:`Deploy keys` tab, and delete the deploy with a title matching the format ``[email protected] (<your-project-slug>)``.
350354
- :ref:`Connect the project to the repository <reference/git-integration:Connect a repository to an existing project>`.
351355

352356
Revoking access
@@ -361,6 +365,7 @@ Revoking access
361365
you will need to :ref:`manually connect your project to the repository <reference/git-integration:Connect a repository to an existing project>`.
362366

363367
You can revoke access to the Read the Docs GitHub App at any time from your GitHub settings.
368+
All revocation options happen from your **account or organization settings**; no action is required inside Read the Docs until you decide to reconnect a project.
364369

365370
- `Read the Docs Community <https://github.com/apps/read-the-docs-community/installations/new/>`__
366371
- `Read the Docs Business <https://github.com/apps/read-the-docs-business/installations/new/>`__

0 commit comments

Comments
 (0)