Skip to content

Commit

Permalink
Docs: Add "Git provider account connection" feature description (#10442)
Browse files Browse the repository at this point in the history
* 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]>
  • Loading branch information
benjaoming and ericholscher authored Jul 5, 2023
1 parent f7d390c commit 84f889a
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 0 deletions.
Binary file added docs/user/img/screenshot-webhook.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs/user/reference/features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ Feature reference
A project may define multiple domains,
as well as define the *canonical domain* where all other domains will redirect.

⏩️ :doc:`/reference/git-integration`
Read the Docs integrates with |git_providers_and|.
This makes your Git repositories easy to import and configure automatically.

Note that we also support other Git providers through :doc:`manual configuration </guides/setup/git-repo-manual>`.

⏩️ :doc:`/versions`
We support multiple versions and translations,
Expand Down Expand Up @@ -67,6 +72,7 @@ Feature reference
:caption: Hosting Features

/custom-domains
/reference/git-integration
/versions
/pull-requests
/build-notifications
Expand Down
67 changes: 67 additions & 0 deletions docs/user/reference/git-integration.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
Git provider integrations
=========================

Your Read the Docs account can be connected to your Git provider's account.
Connecting your account provides the following features:

🔑️ Easy login
Log in to Read the Docs with your |git_providers_or| account.

🔁️ List your projects
Select a project to automatically import from all your Git repositories and organizations.
See: :doc:`/intro/import-guide`.

⚙️ Automatic configuration
Have your Git repository automatically configured with your Read the Docs :term:`webhook`,
which allows Read the Docs to build your docs on every change to your repository.

🚥️ Commit status
See your documentation build status as a commit status indicator on :doc:`pull request builds </pull-requests>`.

.. note::

**Are you using GitHub Enterprise?**
We offer customized enterprise plans for organizations.
Please contact [email protected].

**Other Git providers**
We also generally support all Git providers through :doc:`manual configuration </guides/setup/git-repo-manual>`.

.. figure:: /img/screenshot-webhook.png
:alt: Screenshot of the Dashboard view for the incoming webhook

All calls to the incoming webhook are logged.
Each call can trigger builds and version synchronization.

Read the Docs incoming webhook
------------------------------

Accounts with |git_providers_and| integration automatically have Read the Docs' incoming :term:`webhook` configured on all Git repositories that are imported.
Other setups can setup the webhook through :doc:`manual configuration </guides/setup/git-repo-manual>`.

When an incoming webhook notification is received,
we ensure that it matches an existing Read the Docs project.
Once we have validated the webhook,
we take an action based on the information inside of the webhook.

Possible webhook actions outcomes are:

* :doc:`Builds </builds>` the latest commit.
* Synchronizes your versions based on the latest tag and branch data in Git.
* Runs your :doc:`automation rules</automation-rules>`.
* Auto-cancels any currently running builds of the same version.

Other features enabled by Git integration
-----------------------------------------

We have additional documentation around features provided by our Git integrations:

.. seealso::

:doc:`/pull-requests`
Your Read the Docs project will automatically be configured to send back build notifications,
which can be viewed as commit statuses and on pull requests.

:ref:`sso_git_provider`
Git integration makes it possible for us to synchronize your Git repository's access rights from your Git provider.
That way, the same access rights are effective on Read the Docs and you don't have to configure access in two places.

0 comments on commit 84f889a

Please sign in to comment.