-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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
1 parent
8f583e3
commit 2bf10ec
Showing
5 changed files
with
85 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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|. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |