Skip to content

Docs: Refactor all business features into feature reference + change "privacy level" page (Diátaxis) #10007

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
64 changes: 46 additions & 18 deletions docs/user/commercial/index.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,40 @@
Read the Docs for Business
--------------------------
About |com_brand|
=================
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this work? I never know if it's going to expand first or not.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one worked, but we can't write *|com_brand|* 🤦

image

Copy link
Member

@ericholscher ericholscher Feb 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea... could be a good use case for myst, but not sure if they have substitutions heh :) There's a hack to get nested syntax, I think using another substitution or something janky.


Read the Docs is our community solution for open source projects at `readthedocs.org`_
and we offer Read the Docs for Business
for building and hosting commercial documentation at `readthedocs.com`_.
Features in this section are specific to Read the Docs for Business.
.. this page is currently moving towards becoming "About Read the Docs for Business"
.. rather than an index of features.

We offer |com_brand| for building and hosting commercial documentation.

Our commercial solutions are provided as a set of subscriptions that are paid and managed through an online interface.
In order to get started quickly and easily, a `trial option <https://about.readthedocs.com/pricing/>`__ is provided free of charge.

.. seealso::

`Read the Docs website: Features <https://about.readthedocs.com/about/>`__
A high-level overview of platform features is available on our website, and the
`pricing page <https://about.readthedocs.com/pricing/>`__ has a feature breakdown by subscription level.

`Read the Docs website: Company <https://about.readthedocs.com/company/>`__
Information about the company running Read the Docs, including our mission, team, and community.


Commercial documentation solutions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In addition to providing the same features as |org_brand|,
commercial subscriptions to Read the Docs add additional features and run on separate infrastructure.

.. figure:: /img/community_in_business.png
:align: center
:scale: 50%

Read the Docs for Community and Business are a combined system:
All features developed for community benefit the business solution, and most solutions developed for business users
are implemented for the community.

The following list is a high-level overview of the areas covered by |com_brand|.
If you want a full feature breakdown, please refer to our `pricing page <https://about.readthedocs.com/pricing/>`__.

Private repositories and private documentation
The largest difference between the community solution and our commercial offering
Expand All @@ -15,24 +45,22 @@ Private repositories and private documentation
Additional build resources
Do you have a complicated build process that uses large amounts
of CPU, memory, disk, or networking resources?
Our commercial offering has much higher default resources
that result in faster documentation build times
and we can increase it further for very demanding projects.
Commercial subscriptions offer more resources
which results in faster documentation build times.
We can also customize builders, such as with a GPU or multiple CPUs.

Priority support
We have a dedicated support team that responds to support requests during business hours.
If you need a quick turnaround, please signup for readthedocs.com.

Advertising-free
All commercially hosted documentation is always ad-free.

.. _readthedocs.org: https://readthedocs.org
.. _readthedocs.com: https://readthedocs.com
Business features
Enjoy additional functionality specifically for companies, such as
organization support with team management, single-sign on, and audit logging.

.. toctree::
:caption: Additional commercial features
.. seealso::

organizations
single-sign-on
sharing
privacy-level
- :doc:`/commercial/organizations`
- :doc:`/commercial/single-sign-on`
- :doc:`/security-log`
6 changes: 2 additions & 4 deletions docs/user/commercial/privacy-level.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,8 @@ By default, only users that belong to your organization can see the dashboard of
If you want users outside your organization and anonymous users to be able to see the dashboard of your project,
and the build output of *public versions* you can set the privacy level of your project to ``Public``.

- Go the :guilabel:`Admin` tab of your project.
- Click on :guilabel:`Advanced Settings`.
- Change to :guilabel:`Privacy level` to `Public`.

You can administer this in your :term:`dashboard` by navigating to :menuselection:`Admin --> Advanced Settings`
and changing :guilabel:`Privacy level` to `Public`.

.. note::

Expand Down
1 change: 1 addition & 0 deletions docs/user/guides/administrators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,4 @@ have a look at our :doc:`/tutorial/index`.
manage-read-the-docs-teams
automation-rules
redirects
Managing your Read the Docs for Business subscription </commercial/subscriptions>
Binary file added docs/user/img/community_in_business.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 1 addition & 9 deletions docs/user/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,6 @@ to help you create fantastic documentation for your project.
/subprojects
/single_version
/science
/commercial/organizations
/automatic-redirects

.. toctree::
Expand Down Expand Up @@ -252,14 +251,6 @@ Read the Docs has a commercial offering with improved support and additional fea
:doc:`Sharing externally <commercial/sharing>`


.. toctree::
:maxdepth: 1
:hidden:
:caption: Read the Docs for Business
:glob:

commercial/*

The Read the Docs project and organization
------------------------------------------

Expand Down Expand Up @@ -303,6 +294,7 @@ of Read the Docs and the larger software documentation ecosystem.
changelog

about
/commercial/index
team
open-source-philosophy
story
Expand Down
5 changes: 5 additions & 0 deletions docs/user/reference/features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Features

.. toctree::
:maxdepth: 1
:glob:

../features
analytics
Expand All @@ -20,3 +21,7 @@ Features
/user-defined-redirects
/badges
/security-log
/commercial/organizations
/commercial/privacy-level
/commercial/sharing
/commercial/single-sign-on