Skip to content
Open
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
2 changes: 1 addition & 1 deletion docs/user/commercial/organizations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Organizations allow you to define both individual and team permissions for your
.. seealso::

:doc:`/guides/manage-read-the-docs-teams`
A step-by-step guide to managing teams.
A step-by-step guide to managing organization owners and teams.

Important objects
~~~~~~~~~~~~~~~~~
Expand Down
67 changes: 57 additions & 10 deletions docs/user/guides/manage-read-the-docs-teams.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,62 @@
How to manage Read the Docs teams
=================================
How to manage organization owners and teams
============================================

.. include:: /shared/admonition-rtd-business.rst

Read the Docs uses teams within an organization to group users and provide permissions to projects.
This guide will cover how to do team management,
including adding and removing people from teams.
This guide will cover how to manage both organization owners and team members.
You can read more about organizations and teams in our :doc:`/commercial/organizations` documentation.

Managing organization owners
-----------------------------

Organization owners have full administrative access to the organization and all its projects.
They can manage settings, teams, members, and other owners.

Adding an owner to an organization
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To grant someone full administrative access to your organization, add them as an owner.

.. note::

You must be an owner of the organization to add another owner.

Follow these steps:

1. Navigate to the `organization management page <https://app.readthedocs.com/organizations/choose/organization_detail/>`__.
2. Select your organization from the list.
3. Click on :guilabel:`Settings`.
4. In the sidebar, click on :guilabel:`Owners`.
5. Click :guilabel:`Invite owner`.
6. Enter the user's Read the Docs username or email address.
7. Click :guilabel:`Invite owner`.

The user will receive an invitation and must accept it to become an owner.

Removing an owner from an organization
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To revoke administrative access from an organization owner:

Follow these steps:

1. Navigate to the `organization management page <https://app.readthedocs.com/organizations/choose/organization_detail/>`__.
2. Select your organization from the list.
3. Click on :guilabel:`Settings`.
4. In the sidebar, click on :guilabel:`Owners`.
5. Click :guilabel:`Remove` next to the owner you want to remove.

.. note::

You cannot remove the last owner from an organization.
There must always be at least one owner.

Managing team members
---------------------

Adding a user to a team
-----------------------
~~~~~~~~~~~~~~~~~~~~~~~

Adding a user to a team gives them all the permissions available to that team,
whether it's *read-only* or *admin*.
Expand All @@ -23,7 +70,7 @@ Follow these steps:
5. Click :guilabel:`Add member`.

Removing a user from a team
----------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Removing a user from a team removes all permissions that team gave them.

Expand All @@ -34,14 +81,14 @@ Follow these steps:
3. Click :guilabel:`Remove` next to the user.


Grant access to users to import a project
-----------------------------------------
Granting access to import a project
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Make the user a member of any team with *admin* permissions,
they will be granted access to import a project on that team.

Automating this process
-----------------------
Automating team management
--------------------------

You can manage teams more easily using our :doc:`single sign-on </commercial/single-sign-on>` features.

Expand Down