Add authentication documentation #11834
Open
+132
−2
Conversation
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 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.
agjohnson
reviewed
Dec 11, 2024
| @@ -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> | |||
There was a problem hiding this comment.
Suggested change
| Manage Maintainers </guides/managing-maintainers> | |
| Manage maintainers </guides/managing-maintainers> |
|
|
||
| * Navigate to the :guilabel:`Settings` tab of your project. | ||
| * Click on the :guilabel:`Setup > Maintainers` tab. | ||
| * Click the :guilabel:`Add Maintainer` button. |
There was a problem hiding this comment.
Suggested change
| * Click the :guilabel:`Add Maintainer` button. | |
| * Click the :guilabel:`Add maintainer` button. |
| 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.
I forget what pattern we were using for multiple UI steps in a GUI label but explicit sounds clearer anyways:
Suggested change
| * Click on the :guilabel:`Setup > Maintainers` tab. | |
| * Under :guilabel:`Setup`, click on the :guilabel:`Maintainers` tab. |
Comment on lines
+4
to
+5
| |org_brand| allows you to manage maintainers for your projects. | ||
| Maintainers have admin access to the project, so be careful when adding them. |
There was a problem hiding this comment.
Maybe to just to help make it really clear how this is different from business:
Suggested change
| |org_brand| allows you to manage maintainers for your projects. | |
| Maintainers have admin access to the project, so be careful when adding them. | |
| |org_brand| allows you to manage maintainers for your projects. | |
| Every project is configured with its own list of maintainers | |
| who will all have admin privileges to the project, | |
| so be careful when adding new maintainers. |
| Follow these steps: | ||
|
|
||
| * Navigate to the :guilabel:`Settings` tab of your project. | ||
| * Click on the :guilabel:`Setup > Maintainers` tab. |
Comment on lines
+27
to
+28
| * Automatic repository syncing for easy project import | ||
| * Automatic webhook creation on project import |
There was a problem hiding this comment.
Suggested change
| * Automatic repository syncing for easy project import | |
| * Automatic webhook creation on project import | |
| * Automatic repository syncing for easy project creation | |
| * Automatic webhook creation on project creation |
Comment on lines
+64
to
+65
| 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. |
There was a problem hiding this comment.
Suggested change
| 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. | |
| This means that users can login to Read the Docs with this method, | |
| but we aren't able to determine which projects each user has access to automatically. |
| :ref:`sso_saml` | ||
| Learn how to configure SAML authentication for your organization. | ||
|
|
||
| Two factor authentication |
There was a problem hiding this comment.
Suggested change
| Two factor authentication | |
| Two-factor authentication |
| Two factor authentication | ||
| ------------------------- | ||
|
|
||
| Read the Docs supports Two Factor Authentication (2FA) for added security on all authentication methods. |
There was a problem hiding this comment.
Suggested change
| Read the Docs supports Two Factor Authentication (2FA) for added security on all authentication methods. | |
| Read the Docs supports two-factor authentication (2FA) for added security on all authentication methods. |
| .. seealso:: | ||
|
|
||
| :doc:`/guides/management/2fa` | ||
| Learn how to enable and disable Two Factor Authentication on your account. |
There was a problem hiding this comment.
Suggested change
| Learn how to enable and disable Two Factor Authentication on your account. | |
| Learn how to enable and disable two-factor authentication on your account. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds two pages:
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.
Fixes #11835
📚 Documentation previews 📚
docs): https://docs--11834.org.readthedocs.build/en/11834/dev): https://dev--11834.org.readthedocs.build/en/11834/