You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/user/reference/git-integration.rst
+10-5Lines changed: 10 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -305,11 +305,13 @@ Adding a project from a repository
305
305
306
306
To add a project from a repository,
307
307
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**.
308
310
309
311
- `Read the Docs Community <https://github.com/apps/read-the-docs-community/installations/new/>`__
310
312
- `Read the Docs Business <https://github.com/apps/read-the-docs-business/installations/new/>`__
311
313
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`,
313
315
search for the repository you want to create a project for, and then follow the instructions from there.
314
316
315
317
Connect a repository to an existing project
@@ -318,11 +320,13 @@ Connect a repository to an existing project
318
320
In case you manually added a project on Read the Docs,
319
321
or if you want to connect your project to a different repository,
320
322
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**.
321
325
322
326
- `Read the Docs Community <https://github.com/apps/read-the-docs-community/installations/new/>`__
323
327
- `Read the Docs Business <https://github.com/apps/read-the-docs-business/installations/new/>`__
324
328
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,
326
330
and select the repository you want to connect from the :guilabel:`Connected repository` dropdown.
327
331
328
332
Manually migrating a project
@@ -337,16 +341,16 @@ But in case you need to manually migrate a project,
337
341
you can follow these steps:
338
342
339
343
- 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.
341
345
- 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:
343
347
344
348
- ``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.
345
349
- ``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.
346
350
347
351
- For projects using Read the Docs Business,
348
352
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>)``.
350
354
- :ref:`Connect the project to the repository <reference/git-integration:Connect a repository to an existing project>`.
351
355
352
356
Revoking access
@@ -361,6 +365,7 @@ Revoking access
361
365
you will need to :ref:`manually connect your project to the repository <reference/git-integration:Connect a repository to an existing project>`.
362
366
363
367
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.
364
369
365
370
- `Read the Docs Community <https://github.com/apps/read-the-docs-community/installations/new/>`__
366
371
- `Read the Docs Business <https://github.com/apps/read-the-docs-business/installations/new/>`__
0 commit comments