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: document 2fa #11716

Merged
merged 1 commit into from
Oct 30, 2024
Merged
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
43 changes: 43 additions & 0 deletions docs/user/guides/management/2fa.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
Configuring two-factor authentication
=====================================

Two-factor authentication (2FA) adds an extra layer of security to your Read the Docs account.
When you enable 2FA, you need to provide two pieces of information to log in: your password and a verification code.

Enabling two-factor authentication
----------------------------------

To enable 2FA:

- Go to your account settings.
- Click on :guilabel:`Two-factor authentication`.
- Click on :guilabel:`Activate`.
- Scan the QR code with your authenticator app.
- Enter the verification code from your authenticator app.
- Click on :guilabel:`Activate`.
- Save your recovery codes in a safe place.

.. warning::

If you lose access to your authenticator app, you can use the recovery codes to log in.
Keep them in a safe place, as they are the only way to access your account if you lose your device.

Disabling two-factor authentication
-----------------------------------

To disable 2FA:

- Go to your account settings.
- Click on :guilabel:`Two-factor authentication`.
- Click on :guilabel:`Deactivate`.

Managing recovery codes
-----------------------

To manage your recovery codes:

- Go to your account settings.
- Click on :guilabel:`Two-factor authentication`.
- Click on :guilabel:`Manage recovery codes`.

From there you can download your recovery codes or generate new ones.
4 changes: 4 additions & 0 deletions docs/user/guides/management/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,13 @@ How-to guides: account management
⏩️ :doc:`Managing your Read the Docs for Business subscription </commercial/subscriptions>`
Solving the most common tasks for managing Read the Docs subscriptions.

🔒 :doc:`/guides/management/2fa`
Secure your account with two-factor authentication.
Comment on lines +7 to +8
Copy link
Member

Choose a reason for hiding this comment

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

We should probably have an overview of auth stuff in the docs as well. Just having a guide feels like a good starting point, but I think we want to mention it in other places as well. If there isn't an obvious place to list this as a feature, we should probably create one.

Copy link
Member Author

Choose a reason for hiding this comment

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

yeah, I was having trouble finding a place where to put this content.


.. toctree::
:maxdepth: 1
:hidden:
:glob:

Managing your Read the Docs for Business subscription </commercial/subscriptions>
*
Loading