Skip to content

Docs: Adding a pattern for reusing "Only on Read the Docs for Business" admonition (Diátaxis refactor) #9754

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

Merged
merged 3 commits into from
Nov 23, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
3 changes: 1 addition & 2 deletions docs/user/commercial/organizations.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
Organizations
-------------

.. note::
This feature only exists on `Read the Docs for Business <https://readthedocs.com/>`_.
.. 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,
Expand Down
4 changes: 1 addition & 3 deletions docs/user/commercial/privacy-level.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
Project Privacy Level
---------------------

.. note::

This feature only exists on `Read the Docs for Business <https://readthedocs.com/>`__.
.. include:: /shared/admonition-rtd-business.rst

By default, only users that belong to your organization can see the dashboard of your project and its builds.
If you want users outside your organization and anonymous users to be able to see the dashboard of your project,
Expand Down
10 changes: 4 additions & 6 deletions docs/user/commercial/sharing.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
Sharing
=======

.. note::

This feature only exists on `Read the Docs for Business <https://readthedocs.com/>`__.
.. include:: /shared/admonition-rtd-business.rst

You can share your project with users outside of your company:

Expand Down Expand Up @@ -34,7 +32,7 @@ Enabling Sharing
* Give that information to the person who you want to give access.

.. note::

You can always revoke access in the same panel.

Users can log out by using the :ref:`Log Out <versions:Logging out>` link in the RTD flyout menu.
Expand Down Expand Up @@ -85,7 +83,7 @@ The header has the form ``Authorization: Token <ACCESS_TOKEN>``.
For example:

.. prompt:: bash $

curl -H "Authorization: Token 19okmz5k0i6yk17jp70jlnv91v" https://docs.example.com/en/latest/example.html

Basic Authorization
Expand All @@ -95,5 +93,5 @@ You can also use basic authorization, with the token as user and an empty passwo
For example:

.. prompt:: bash $

curl --url https://docs.example.com/en/latest/example.html --user '19okmz5k0i6yk17jp70jlnv91v:'
9 changes: 3 additions & 6 deletions docs/user/commercial/single-sign-on.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
Single Sign-On
==============

.. note::

This feature only exists on `Read the Docs for Business <https://readthedocs.com/>`__.

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

Single sign-on is supported on |com_brand| for all users.
:abbr:`SSO (single sign-on)` will allow you to grant permissions to your organization's projects in an easy way.
Expand Down Expand Up @@ -34,10 +31,10 @@ your organization's detail page > :guilabel:`Settings` > :guilabel:`Authorizatio
and selecting :guilabel:`GitHub, GitLab or Bitbucket` as provider.

Note the users created under Read the Docs must have their GitHub, Bitbucket or GitLab
:doc:`account connected </connected-accounts>` in order to make SSO work.
:doc:`account connected </connected-accounts>` in order to make SSO work.
You can read more about `granting permissions on GitHub`_.

.. warning:: Once you enable this option, your existing Read the Docs teams will not be used.
.. warning:: Once you enable this option, your existing Read the Docs teams will not be used.

.. _granting permissions on GitHub: https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization

Expand Down
2 changes: 2 additions & 0 deletions docs/user/shared/admonition-rtd-business.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. note::
This feature only exists on `Read the Docs for Business <https://readthedocs.com/>`_.