Skip to content

Commit

Permalink
Add authentication documentation
Browse files Browse the repository at this point in the history
This adds two pages:

* A intro reference page on authentication methods
* A guide on managing maintainers for Community

These are just basic places to start on this content.
I wasn't 100% sure the best way to structure the Authencation methods page,
so definitely would like feedback on that one.
  • Loading branch information
ericholscher committed Dec 10, 2024
1 parent 8f583e3 commit 2bf10ec
Show file tree
Hide file tree
Showing 5 changed files with 85 additions and 2 deletions.
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>
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.

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.
* 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.
* 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
39 changes: 39 additions & 0 deletions docs/user/intro/accounts.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
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.

.. seealso::

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

Two factor authentication
-------------------------

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.

0 comments on commit 2bf10ec

Please sign in to comment.