Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Relabel and move explanation and how-tos around OAuth (Diátaxis) #9834

Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
e477553
WIP: Refactor explanation/howto revolving around OAuth
benjaoming Dec 21, 2022
8df0f34
Merge branch 'diataxis/main' of github.com:readthedocs/readthedocs.or…
benjaoming Jan 3, 2023
3194bac
Make it more clear to some users that they don't need to do anything …
benjaoming Jan 3, 2023
b09010d
Tested GitLab and Bitbucket, we need to add one permission to the list
benjaoming Jan 3, 2023
e8be1db
Adds a seealso:: back from howto to explanation
benjaoming Jan 3, 2023
4feccfd
Apply suggestions from code review @ericholscher
benjaoming Jan 4, 2023
ab8aaaa
read the dots - list entries end with a period
benjaoming Jan 4, 2023
2c1c278
Adds more explanation about how OAuth works and organizes permissions…
benjaoming Jan 4, 2023
76825b5
Merge branch 'diataxis/relabel-connected-accounts' of github.com:benj…
benjaoming Jan 4, 2023
8efb8d1
Add link to OAuth, remove redundant seealso
benjaoming Jan 5, 2023
995edbc
Update how-to guide and use place-holders for screenshots
benjaoming Jan 11, 2023
1020f08
Clarify ambiguous sign-up text
benjaoming Jan 11, 2023
f07de58
Add subsection about disconnecting a service
benjaoming Jan 11, 2023
ad99ed2
Add screenshots to howto
benjaoming Jan 12, 2023
fcee665
pre-commit is lit :fire:
benjaoming Jan 12, 2023
6e17ca2
Move to Explanation TOC section
benjaoming Jan 12, 2023
1b1adb4
Merge branch 'diataxis/main' of github.com:readthedocs/readthedocs.or…
benjaoming Jan 13, 2023
561fc91
Apply suggestions from code review @ericholscher
benjaoming Jan 13, 2023
4d1f205
Merge branch 'diataxis/relabel-connected-accounts' of github.com:benj…
benjaoming Jan 13, 2023
fd274d3
Apply the new substitution for Git providers
benjaoming Jan 13, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 37 additions & 13 deletions docs/user/connected-accounts.rst
Original file line number Diff line number Diff line change
@@ -1,28 +1,51 @@
Connecting Your VCS Account
===========================
Connecting your Git repository
==============================

In this article, we explain how connecting your Read the Docs account to one of the supported Git providers
automatically configures your Git repository and your Read the Docs project.

✅️ Signed up with your Git provider?
If you signed up or logged in to Read the Docs with your GitHub, Bitbucket, or GitLab
credentials, you're all done. Your account is connected and the integration explained
below is enabled.
⬇️ Signed up with your email address?
If you have signed up to Read the Docs with your email address,
you can add the connection to the Git provider afterwards.
Read more about how it works below.
ericholscher marked this conversation as resolved.
Show resolved Hide resolved


If you are going to import repositories from GitHub, Bitbucket, or GitLab,
you should connect your Read the Docs account to your repository host first.
we recommend that you connect your Read the Docs account to your repository provider.
benjaoming marked this conversation as resolved.
Show resolved Hide resolved

Connecting your account allows for:

* Easier importing of your repositories
* Automatically configure your repository :doc:`/integrations`
* Easy import of your repositories
* Automatic configuration of your repository :doc:`/integrations`
which allow Read the Docs to build your docs on every change to your repository
* Log into Read the Docs with your GitHub, Bitbucket, or GitLab credentials
* Logging into Read the Docs with your GitHub, Bitbucket, or GitLab credentials
benjaoming marked this conversation as resolved.
Show resolved Hide resolved


.. seealso::

:doc:`/guides/connecting-git-account`
Here are the steps to connect your Read the Docs account to your Git repository provider.

:ref:`intro/import-guide:Manually import your docs`
Using a different provider?
Read the Docs still supports other providers such as Gitea or GitHub Enterprise.
In fact, any Git repository URL can be configured manually.


If you signed up or logged in to Read the Docs with your GitHub, Bitbucket, or GitLab
credentials, you're all done. Your account is connected.
.. tip::

To connect a social account, go to your :guilabel:`<Username dropdown>` > :guilabel:`Settings` > :guilabel:`Connected Services`.
From here, you'll be able to connect to your GitHub, Bitbucket or GitLab
account. This process will ask you to authorize a connection to Read the Docs,
that allows us to read information about and clone your repositories.
A single Read the Docs account can connect to many different Git providers.
This allows you to have a single login for all your various identities.


Permissions for connected accounts
----------------------------------

Read the Docs does not generally ask for write permission to your repositories' code
Read the Docs does not generally ask for *write* permission to your repository code
(with one exception detailed below)
and since we only connect to public repositories we don't need special permissions to read them.
However, we do need permissions for authorizing your account
Expand Down Expand Up @@ -103,6 +126,7 @@ Bitbucket

For similar reasons to those above for GitHub, we request permissions for:

* Administering your repositories (to add a read-only deployment key)
benjaoming marked this conversation as resolved.
Show resolved Hide resolved
* Reading your account information including your email address
* Read access to your team memberships
* Read access to your repositories
Expand Down
1 change: 1 addition & 0 deletions docs/user/guides/administrators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ have a look at our :doc:`/tutorial/index`.
:maxdepth: 1

Connect your git repository <git-integrations>
Connect your Read the Docs account to your Git repository <connecting-git-account>
Manage Custom Domains <custom-domains>
Enable Canonical URLs <canonical-urls>
technical-docs-seo-guide
Expand Down
22 changes: 22 additions & 0 deletions docs/user/guides/connecting-git-account.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
How to connect your Read the Docs account to your Git repository
================================================================

If you are going to import repositories from GitHub, Bitbucket, or GitLab,
you should connect your Read the Docs account to your repository host first.

.. note::

If you signed up or logged in to Read the Docs with your GitHub, Bitbucket, or GitLab credentials,
you're all done. Your account is connected ✅️.

To connect a social account, go to your :guilabel:`<Username dropdown>` > :guilabel:`Settings` > :guilabel:`Connected Services`.
benjaoming marked this conversation as resolved.
Show resolved Hide resolved

From here, you'll be able to connect to your GitHub, Bitbucket or GitLab
account. This process will ask you to authorize a connection to Read the Docs,
that allows us to read information about and clone your repositories.


.. seealso::

:doc:`/connected-accounts`
Learn about the permissions required for connecting accounts and the benefits of the OAuth integration.
8 changes: 7 additions & 1 deletion docs/user/intro/import-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ these properties, and then click **Next** to
Manually import your docs
-------------------------

If you do not have a connected account, you will need to select **Import Manually**
If you have not :ref:`connected a Git provider account <guides/connecting-git-account:How to connect your Read the Docs account to your Git repository>`,
you will need to select **Import Manually**
and enter the information for your repository yourself. You will also need to
manually configure the webhook for your repository as well. When importing your
project, you will be asked for the repository URL, along with some other
Expand All @@ -53,6 +54,11 @@ project on Read the Docs. Go to your project's :guilabel:`Admin` > :guilabel:`In
configure a new webhook, or see :ref:`our steps for webhook creation <integrations:Integration Creation>`
for more information on this process.

.. seealso::

:doc:`/guides/git-integrations`
Once you have imported your git project, use this guide to manually set up basic and additional integration.

.. note::
The ``Admin`` page can be found at ``https://readthedocs.org/dashboard/<project-slug>/edit/``.
You can access all of the project settings from the admin page sidebar.
Expand Down