Skip to content

Commit 2bf10ec

Browse files
committed
Add authentication documentation
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.
1 parent 8f583e3 commit 2bf10ec

File tree

5 files changed

+85
-2
lines changed

5 files changed

+85
-2
lines changed

docs/user/guides/access/index.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ How-to guides: security and access
2727
a :ref:`private Git repository <guides/private-python-packages:From a Git repository>` or
2828
a :ref:`private repository manager <guides/private-python-packages:From a repository manager other than PyPI>`.
2929

30+
⏩️ :doc:`Manage Maintainers </guides/managing-maintainers>`
31+
Learn how to manage maintainers for your projects on |org_brand|.
32+
3033
.. toctree::
3134
:maxdepth: 1
3235
:hidden:
@@ -38,3 +41,4 @@ How-to guides: security and access
3841
Manually importing private repositories </guides/importing-private-repositories>
3942
Using private Git submodules </guides/private-submodules>
4043
Installing private python packages </guides/private-python-packages>
44+
Manage Maintainers </guides/managing-maintainers>

docs/user/guides/manage-read-the-docs-teams.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
.. TODO: We should documentation how community team management works
2-
31
How to manage Read the Docs teams
42
=================================
53

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
How to manage maintainers for your project
2+
==========================================
3+
4+
|org_brand| allows you to manage maintainers for your projects.
5+
Maintainers have admin access to the project, so be careful when adding them.
6+
7+
When you add a maintainer to your project,
8+
they will be invited to join the project as a maintainer.
9+
They will receive an email notification with a link to accept the invitation,
10+
and won't have access to the project until they accept the invitation.
11+
12+
Adding a maintainer
13+
-------------------
14+
15+
Adding a maintainer gives them admin access to your project.
16+
17+
Follow these steps:
18+
19+
* Navigate to the :guilabel:`Settings` tab of your project.
20+
* Click on the :guilabel:`Setup > Maintainers` tab.
21+
* Click the :guilabel:`Add Maintainer` button.
22+
* Fill out the form with the new maintainer's username or email address.
23+
* Click :guilabel:`Invite`.
24+
25+
Removing a maintainer
26+
---------------------
27+
28+
Removing a maintainer revokes their admin access to your project.
29+
30+
Follow these steps:
31+
32+
* Navigate to the :guilabel:`Settings` tab of your project.
33+
* Click on the :guilabel:`Setup > Maintainers` tab.
34+
* Find the maintainer you want to remove in the list.
35+
* Click the :guilabel:`Remove` button next to their name.
36+
* Confirm the removal in the dialog that appears.
37+
38+
.. seealso::
39+
40+
:doc:`/guides/manage-read-the-docs-teams`
41+
Learn how to manage teams within an organization on |com_brand|.

docs/user/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Read the Docs: documentation simplified
1414
/intro/markdoc
1515
/intro/add-project
1616
/examples
17+
/intro/accounts
1718

1819
.. toctree::
1920
:maxdepth: 2

docs/user/intro/accounts.rst

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
Account authentication methods
2+
==============================
3+
4+
Read the Docs supports several authentication methods for creating an account and logging in.
5+
The method you choose depends on your preferences and the security requirements of your organization.
6+
7+
These authentication methods are not mutually exclusive,
8+
you can use multiple methods to access your account.
9+
10+
Email and password
11+
------------------
12+
13+
You can create an account on Read the Docs using your email address and a password.
14+
This method works well for individual users and small teams,
15+
but it limits the functionality available to you.
16+
17+
VCS provider authentication
18+
---------------------------
19+
20+
You can also create an account on Read the Docs using a VCS authentication provider: GitHub, GitLab, or Bitbucket.
21+
This method is more secure and convenient than using an email and password,
22+
and provides access to additional features like automatic repository syncing.
23+
24+
.. seealso::
25+
26+
:doc:`/guides/connecting-git-account`
27+
Learn how to connect your Read the Docs account with a Git provider.
28+
29+
Two factor authentication
30+
-------------------------
31+
32+
Read the Docs supports Two Factor Authentication (2FA) for added security on all authentication methods.
33+
If you have 2FA enabled on your account, you will be prompted to enter a code
34+
when logging in.
35+
36+
.. seealso::
37+
38+
:doc:`/guides/management/2fa`
39+
Learn how to enable and disable Two Factor Authentication on your account.

0 commit comments

Comments
 (0)