Skip to content

Commit 84f889a

Browse files
Docs: Add "Git provider account connection" feature description (#10442)
* Add "Git provider account connection" to docs: Scissor out and update work from benjaoming#5 * Turn bullet list "wall of text" into a description list * Copy edit the docs page. --------- Co-authored-by: Eric Holscher <[email protected]>
1 parent f7d390c commit 84f889a

File tree

3 files changed

+73
-0
lines changed

3 files changed

+73
-0
lines changed

docs/user/img/screenshot-webhook.png

375 KB
Loading

docs/user/reference/features.rst

+6
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ Feature reference
99
A project may define multiple domains,
1010
as well as define the *canonical domain* where all other domains will redirect.
1111

12+
⏩️ :doc:`/reference/git-integration`
13+
Read the Docs integrates with |git_providers_and|.
14+
This makes your Git repositories easy to import and configure automatically.
15+
16+
Note that we also support other Git providers through :doc:`manual configuration </guides/setup/git-repo-manual>`.
1217

1318
⏩️ :doc:`/versions`
1419
We support multiple versions and translations,
@@ -67,6 +72,7 @@ Feature reference
6772
:caption: Hosting Features
6873

6974
/custom-domains
75+
/reference/git-integration
7076
/versions
7177
/pull-requests
7278
/build-notifications
+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
Git provider integrations
2+
=========================
3+
4+
Your Read the Docs account can be connected to your Git provider's account.
5+
Connecting your account provides the following features:
6+
7+
🔑️ Easy login
8+
Log in to Read the Docs with your |git_providers_or| account.
9+
10+
🔁️ List your projects
11+
Select a project to automatically import from all your Git repositories and organizations.
12+
See: :doc:`/intro/import-guide`.
13+
14+
⚙️ Automatic configuration
15+
Have your Git repository automatically configured with your Read the Docs :term:`webhook`,
16+
which allows Read the Docs to build your docs on every change to your repository.
17+
18+
🚥️ Commit status
19+
See your documentation build status as a commit status indicator on :doc:`pull request builds </pull-requests>`.
20+
21+
.. note::
22+
23+
**Are you using GitHub Enterprise?**
24+
We offer customized enterprise plans for organizations.
25+
Please contact [email protected].
26+
27+
**Other Git providers**
28+
We also generally support all Git providers through :doc:`manual configuration </guides/setup/git-repo-manual>`.
29+
30+
.. figure:: /img/screenshot-webhook.png
31+
:alt: Screenshot of the Dashboard view for the incoming webhook
32+
33+
All calls to the incoming webhook are logged.
34+
Each call can trigger builds and version synchronization.
35+
36+
Read the Docs incoming webhook
37+
------------------------------
38+
39+
Accounts with |git_providers_and| integration automatically have Read the Docs' incoming :term:`webhook` configured on all Git repositories that are imported.
40+
Other setups can setup the webhook through :doc:`manual configuration </guides/setup/git-repo-manual>`.
41+
42+
When an incoming webhook notification is received,
43+
we ensure that it matches an existing Read the Docs project.
44+
Once we have validated the webhook,
45+
we take an action based on the information inside of the webhook.
46+
47+
Possible webhook actions outcomes are:
48+
49+
* :doc:`Builds </builds>` the latest commit.
50+
* Synchronizes your versions based on the latest tag and branch data in Git.
51+
* Runs your :doc:`automation rules</automation-rules>`.
52+
* Auto-cancels any currently running builds of the same version.
53+
54+
Other features enabled by Git integration
55+
-----------------------------------------
56+
57+
We have additional documentation around features provided by our Git integrations:
58+
59+
.. seealso::
60+
61+
:doc:`/pull-requests`
62+
Your Read the Docs project will automatically be configured to send back build notifications,
63+
which can be viewed as commit statuses and on pull requests.
64+
65+
:ref:`sso_git_provider`
66+
Git integration makes it possible for us to synchronize your Git repository's access rights from your Git provider.
67+
That way, the same access rights are effective on Read the Docs and you don't have to configure access in two places.

0 commit comments

Comments
 (0)