-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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
|
||||||||||||||
|
||||||||||||||
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. | ||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 the :guilabel:`Add Maintainer` button. | ||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
* 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. | ||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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|. |
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
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
||||||||||
.. 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
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
||||||||||
.. seealso:: | ||||||||||
|
||||||||||
:ref:`sso_saml` | ||||||||||
Learn how to configure SAML authentication for your organization. | ||||||||||
|
||||||||||
Two factor authentication | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
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. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.