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

Add authentication documentation #11834

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions docs/user/commercial/single-sign-on.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ including any two-factor authentication and additional Single Sign-on that they

Learn how to configure this SSO method with our :doc:`/guides/setup-single-sign-on-github-gitlab-bitbucket`.

.. _sso_google_workspace:

SSO with Google Workspace
-------------------------

Expand All @@ -42,6 +44,8 @@ permissions are managed by the :ref:`internal Read the Docs's teams <commercial/
This feature is only available on the **Pro plan** and above.
Learn how to configure this SSO method with our :doc:`/guides/setup-single-sign-on-google-email`.

.. _sso_saml:

SSO with SAML
-------------

Expand Down
4 changes: 4 additions & 0 deletions docs/user/guides/access/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ How-to guides: security and access
a :ref:`private Git repository <guides/private-python-packages:From a Git repository>` or
a :ref:`private repository manager <guides/private-python-packages:From a repository manager other than PyPI>`.

⏩️ :doc:`Manage Maintainers </guides/managing-maintainers>`
Learn how to manage maintainers for your projects on |org_brand|.

.. toctree::
:maxdepth: 1
:hidden:
Expand All @@ -38,3 +41,4 @@ How-to guides: security and access
Manually importing private repositories </guides/importing-private-repositories>
Using private Git submodules </guides/private-submodules>
Installing private python packages </guides/private-python-packages>
Manage Maintainers </guides/managing-maintainers>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Manage Maintainers </guides/managing-maintainers>
Manage maintainers </guides/managing-maintainers>

2 changes: 0 additions & 2 deletions docs/user/guides/manage-read-the-docs-teams.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
.. TODO: We should documentation how community team management works

How to manage Read the Docs teams
=================================

Expand Down
41 changes: 41 additions & 0 deletions docs/user/guides/managing-maintainers.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
How to manage maintainers for your project
==========================================

|org_brand| allows you to manage maintainers for your projects.
Maintainers have admin access to the project, so be careful when adding them.
Comment on lines +4 to +5
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe to just to help make it really clear how this is different from business:

Suggested change
|org_brand| allows you to manage maintainers for your projects.
Maintainers have admin access to the project, so be careful when adding them.
|org_brand| allows you to manage maintainers for your projects.
Every project is configured with its own list of maintainers
who will all have admin privileges to the project,
so be careful when adding new maintainers.


When you add a maintainer to your project,
they will be invited to join the project as a maintainer.
They will receive an email notification with a link to accept the invitation,
and won't have access to the project until they accept the invitation.

Adding a maintainer
-------------------

Adding a maintainer gives them admin access to your project.

Follow these steps:

* Navigate to the :guilabel:`Settings` tab of your project.
* Click on the :guilabel:`Setup > Maintainers` tab.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I forget what pattern we were using for multiple UI steps in a GUI label but explicit sounds clearer anyways:

Suggested change
* Click on the :guilabel:`Setup > Maintainers` tab.
* Under :guilabel:`Setup`, click on the :guilabel:`Maintainers` tab.

* Click the :guilabel:`Add Maintainer` button.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Click the :guilabel:`Add Maintainer` button.
* Click the :guilabel:`Add maintainer` button.

* Fill out the form with the new maintainer's username or email address.
* Click :guilabel:`Invite`.

Removing a maintainer
---------------------

Removing a maintainer revokes their admin access to your project.

Follow these steps:

* Navigate to the :guilabel:`Settings` tab of your project.
* Click on the :guilabel:`Setup > Maintainers` tab.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above here

* Find the maintainer you want to remove in the list.
* Click the :guilabel:`Remove` button next to their name.
* Confirm the removal in the dialog that appears.

.. seealso::

:doc:`/guides/manage-read-the-docs-teams`
Learn how to manage teams within an organization on |com_brand|.
1 change: 1 addition & 0 deletions docs/user/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Read the Docs: documentation simplified
/intro/markdoc
/intro/add-project
/examples
/intro/accounts

.. toctree::
:maxdepth: 2
Expand Down
82 changes: 82 additions & 0 deletions docs/user/intro/accounts.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
Account authentication methods
==============================

Read the Docs supports several authentication methods for creating an account and logging in.
The method you choose depends on your preferences and the security requirements of your organization.

These authentication methods are not mutually exclusive,
you can use multiple methods to access your account.

Email and password
------------------

You can create an account on Read the Docs using your email address and a password.
This method works well for individual users and small teams,
but it limits the functionality available to you.

VCS provider authentication
---------------------------

You can also create an account on Read the Docs using a VCS authentication provider: GitHub, GitLab, or Bitbucket.
This method is more secure and convenient than using an email and password,
and provides access to additional features like automatic repository syncing.

VCS provider authentication is required for the following features:

* :doc:`/pull-requests`
* Automatic repository syncing for easy project import
* Automatic webhook creation on project import
Comment on lines +27 to +28
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Automatic repository syncing for easy project import
* Automatic webhook creation on project import
* Automatic repository syncing for easy project creation
* Automatic webhook creation on project creation


.. seealso::

:doc:`/guides/connecting-git-account`
Learn how to connect your Read the Docs account with a Git provider.

Google authentication
---------------------

.. include:: /shared/admonition-rtd-business.rst

Read the Docs supports Google authentication for organizations.
Google authentication works well for users already using Google services,
and easily integrates into your existing workflow.

Google provides authentication, but not authorization.
This means that you can login to Read the Docs with this method,
but we aren't able to determine which projects you have access to automatically.

.. seealso::

:ref:`sso_google_workspace`
Learn how to configure Google authentication for your organization.

SAML authentication
-------------------

.. include:: /shared/admonition-rtd-business.rst

Read the Docs supports SAML authentication for organizations.
SAML authentication is a secure way to authenticate users and manage access to your organization's projects.
This is only available on Enterprise plans,
and requires custom integration to be enabled.

SAML provides authentication, but not authorization.
This means that you can login to Read the Docs with this method,
but we aren't able to determine which projects you have access to automatically.
Comment on lines +64 to +65
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This means that you can login to Read the Docs with this method,
but we aren't able to determine which projects you have access to automatically.
This means that users can login to Read the Docs with this method,
but we aren't able to determine which projects each user has access to automatically.


.. seealso::

:ref:`sso_saml`
Learn how to configure SAML authentication for your organization.

Two factor authentication
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Two factor authentication
Two-factor authentication

-------------------------

Read the Docs supports Two Factor Authentication (2FA) for added security on all authentication methods.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Read the Docs supports Two Factor Authentication (2FA) for added security on all authentication methods.
Read the Docs supports two-factor authentication (2FA) for added security on all authentication methods.

If you have 2FA enabled on your account, you will be prompted to enter a code
when logging in.

.. seealso::

:doc:`/guides/management/2fa`
Learn how to enable and disable Two Factor Authentication on your account.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Learn how to enable and disable Two Factor Authentication on your account.
Learn how to enable and disable two-factor authentication on your account.