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.

Sign up for GitHub

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: Relabel Organizations as Explanation (Diátaxis) #9836

Merged
merged 6 commits into from
Jan 3, 2023
Merged

Docs: Relabel Organizations as Explanation (Diátaxis) #9836

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
286a10f
WIP: Rephrase Organization as an explanation article, include current…
benjaoming Dec 21, 2022
c20787d
Apply suggestions from code review @ericholscher
benjaoming Dec 22, 2022
69d094e
Merge branch 'diataxis/main' into diataxis/relabel-organizations
benjaoming Dec 22, 2022
555c888
Change heading of Organizations article
benjaoming Dec 23, 2022
f3613e2
Merge branch 'diataxis/main' of github.com:readthedocs/readthedocs.or…
benjaoming Dec 23, 2022
73f899f
Merge branch 'diataxis/relabel-organizations' of github.com:benjaomin…
benjaoming Dec 23, 2022
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
16 changes: 11 additions & 5 deletions docs/user/commercial/organizations.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,21 @@
Organizations
-------------
Organizations: permissions for projects and teams
-------------------------------------------------

benjaoming marked this conversation as resolved.
Show resolved Hide resolved
.. include:: /shared/admonition-rtd-business.rst

Organizations allow you to segment who has access to what projects in your company.
Your company will be represented as an Organization,
let's use ACME Corporation as our example.
In this article, we explain how the *organizations* feature on Read the Docs allows you to manage access to your projects.
On |com_brand|, your account is linked to an *organization*.
Organizations allow you to define both individual and team permissions for your projects.

In this article, we use ACME Corporation as our example organization.
ACME has a few people inside their organization,
some who need full access and some who just need access to one project.

.. seealso::

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

Member Types
~~~~~~~~~~~~

Expand Down
7 changes: 6 additions & 1 deletion docs/user/guides/manage-read-the-docs-teams.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
How to manage Read the Docs 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.
Expand Down Expand Up @@ -38,4 +40,7 @@ Automating this process

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

.. seealso:: Our infomation on :doc:`/commercial/organizations`.
.. seealso::

:doc:`/commercial/organizations`
General information about the *organizations* feature.
1 change: 1 addition & 0 deletions docs/user/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ to help you create fantastic documentation for your project.
/subprojects
/single_version
/science
/commercial/organizations

.. toctree::
:maxdepth: 2
Expand Down