Skip to content

Commit eaae969

Browse files
authored
Merge pull request #6004 from readthedocs/davidfischer/commercial-docs-links
Link to Read the Docs for Business docs from relevant sections
2 parents 19485e4 + ab377fb commit eaae969

13 files changed

+52
-23
lines changed

docs/advertising/ethical-advertising.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -175,8 +175,8 @@ We have added multiple ways to opt out of the advertising on Read the Docs.
175175
* Change your advertising settings
176176

177177
4. If you are part of a company that uses Read the Docs to host documentation for a commercial product,
178-
we offer `paid plans`_ on readthedocs.com that offer a completely ad-free experience, additional build resources,
179-
and features like CDN support and private documentation.
178+
we offer :doc:`Read the Docs for Business </commercial/index>` that offers a completely ad-free experience,
179+
additional build resources, and other great features like CDN support and private documentation.
180180

181181
5. If you would like to completely remove advertising from your open source project,
182182
but our commercial plans don't seem like the right fit,

docs/advertising/index.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ You may :ref:`opt out of paid advertising <advertising/ethical-advertising:Optin
2525
-- you will still see :ref:`community ads <advertising/ethical-advertising:Community Ads>` --
2626
or you can go ad-free by `becoming a Gold Member`_ or a `Supporter`_ of Read the Docs.
2727

28+
For businesses looking to remove advertising,
29+
please consider :doc:`Read the Docs for Business </commercial/index>`.
30+
2831
.. _becoming a Gold Member: https://readthedocs.org/accounts/gold/
2932
.. _Supporter: https://readthedocs.org/sustainability/#donations
3033

docs/builds.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ Our current build limits are:
1414

1515
We can increase build limits on a per-project basis,
1616
sending an email to [email protected] providing a good reason why your documentation needs more resources.
17+
If your business is hitting build limits hosting documentation on Read the Docs,
18+
please consider :doc:`Read the Docs for Business </commercial/index>`
19+
which has much higher build resources.
1720

1821
You can see the current Docker build images that we use in our `docker repository <https://github.com/readthedocs/readthedocs-docker-images>`_.
1922
`Docker Hub <https://hub.docker.com/r/readthedocs/build/>`_ also shows the latest set of images that have been built.

docs/commercial/custom_domains.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
Custom Domains
22
==============
33

4+
.. note:: These directions are for projects hosted on Read the Docs for Business.
5+
For setting up a custom domain on a project hosted on readthedocs.org,
6+
please read our :doc:`community documentation </custom_domains>`.
7+
48
Subdomain support
59
-----------------
610

7-
Once a project is imported under Read the Docs,
11+
Once a project is imported into Read the Docs,
812
by default it's hosted under a subdomain on one of our domains.
9-
If you need a custom domain, continue on custom domain setup.
13+
If you need a custom domain, continue on to custom domain setup.
1014

1115

1216
Serving documentation with a custom domain

docs/commercial/index.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1-
Read the Docs Commercial Features
2-
---------------------------------
1+
Read the Docs for Business
2+
--------------------------
33

4-
Read the Docs has a community solution for open source projects on `readthedocs.org`_
5-
and we offer commercial documentation building and hosting on `readthedocs.com`_.
6-
Features in this section are specific to our commercial offering.
4+
Read the Docs is our community solution for open source projects at `readthedocs.org`_
5+
and we offer Read the Docs for Business
6+
for building and hosting commercial documentation at `readthedocs.com`_.
7+
Features in this section are specific to Read the Docs for Business.
78

89
Private repositories and private documentation
910
The largest difference between the community solution and our commercial offering

docs/commercial/organizations.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
Organizations
22
-------------
33

4+
.. note::
5+
This feature only exists on `Read the Docs for Business <https://readthedocs.com/>`_.
6+
47
Organizations allow you to segment who has access to what projects in your company.
58
Your company will be represented as an Organization,
69
let's use ACME Corporation as our example.

docs/commercial/sharing.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
Sharing
22
-------
33

4-
.. note:: This feature only exists on our Business offering at `readthedocs.com <https://readthedocs.com/>`_.
4+
.. note::
5+
This feature only exists on `Read the Docs for Business <https://readthedocs.com/>`_.
56

67
You can share your project with users outside of your company.
78
There are two ways to do this:

docs/custom_domains.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
Custom Domains
22
==============
33

4-
.. note:: These setup directions are for our community site.
5-
If you want to setup a custom domain under our `commercial hosting`_,
6-
please read our :ref:`commercial documentation <commercial/custom_domains:Custom Domains>`.
7-
8-
.. _commercial hosting: https://readthedocs.com
4+
.. note:: These directions are for projects hosted on our community site.
5+
If you want to setup a custom domain on `Read the Docs for Business <https://readthedocs.com/>`_,
6+
please read our :doc:`commercial documentation <commercial/custom_domains>`.
97

108
Read the Docs supports a number of custom domains for your convenience. Shorter URLs make everyone happy, and we like making people happy!
119

docs/custom_installs/index.rst

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,20 @@
11
Info about custom installs
22
==========================
33

4-
Read the Docs is open source, which means you can run your own version of it. There are many reasons to do this, the main one being if you want a private instance. If you have to keep everything behind a firewall or VPN, this is for you.
4+
Read the Docs is open source, which means you can run your own version of it.
5+
There are many reasons to do this, the main one being if you want a private instance.
6+
If you have to keep everything behind a firewall or VPN, this is for you.
57

6-
.. warning:: Read the Docs developers do not support custom installs of our software. These documents are maintained by the community, and might not be up to date.
8+
If your main reasons for considering a custom installation
9+
are to connect to private repositories or to have fine grained access control over your documentation,
10+
please consider :doc:`Read the Docs for Business </commercial/index>`.
11+
It has those features and more!
712

13+
.. warning::
14+
These documents are maintained by the community, and might not be up to date.
15+
Read the Docs developers do not support custom installs of our software
16+
in our public issue tracker. For additional support of a custom installation,
17+
please see our `paid support plans <https://readthedocs.com/services/#open-source-support>`_.
818

919
.. toctree::
1020
:maxdepth: 2

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ of Read the Docs and the larger software documentation ecosystem.
176176
:doc:`advertising/index` |
177177
:doc:`Sponsors <sponsors>`
178178

179-
* **Read the Docs for business**:
179+
* **Read the Docs for Business**:
180180
:doc:`Support and additional features <commercial/index>`
181181

182182
* **Running your own version of Read the Docs**:

docs/intro/import-guide.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Importing Your Documentation
55
:description lang=en: Import your existing technical documentation from version control into Read the Docs.
66

77

8-
To import a public documentation repository, visit your `Read the Docs dashboard`_ and click Import_. For private
9-
repositories, use the Read the Docs :doc:`commercial solution <../commercial/index>`.
8+
To import a public documentation repository, visit your `Read the Docs dashboard`_ and click Import_.
9+
For private repositories, please use :doc:`Read the Docs for Business </commercial/index>`.
1010

1111

1212
If you have :doc:`connected your Read the Docs account <../connected-accounts>` to GitHub, Bitbucket, or GitLab,

docs/privacy.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
Privacy Levels
22
==============
33

4+
.. note::
5+
For private documentation or docs from private repositories,
6+
use :doc:`Read the Docs for Business </commercial/index>`.
7+
48
Read the Docs supports 3 different privacy levels on 2 different objects;
59
Public, Private on Projects and Versions.
610

docs/support.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,11 @@ Send an email to [email protected].
5757
Commercial Support
5858
------------------
5959

60-
We offer commercial support for Read the Docs, :doc:`commercial hosting </commercial/index>`,
61-
as well as consulting around all documentation systems.
62-
You can contact us at [email protected] to learn more,
60+
We offer commercial support with :doc:`Read the Docs for Business </commercial/index>`
61+
and we have a dedicated team that responds to support requests during business hours.
62+
63+
For consulting services around documentation systems,
64+
you can `contact us <mailto:[email protected]?subject=Consulting%20Services%20Inquiry>`_
6365
or read more at https://readthedocs.com/services/#open-source-support.
6466

6567
.. _Stack Overflow: http://stackoverflow.com/questions/tagged/read-the-docs

0 commit comments

Comments
 (0)