Copy feedback
* use commercial instead of business * Custom Domain instead CNAM * paraphrase some sentences * rename alternate_domain.rst to custom_domain.rstadd-modified-date-importedfile
parent
6d1da8be05
commit
35f400d8aa
|
@ -1,32 +0,0 @@
|
||||||
Alternate Domains
|
|
||||||
=================
|
|
||||||
|
|
||||||
Read the Docs supports a number of custom domains for your convenience.
|
|
||||||
|
|
||||||
Subdomain support
|
|
||||||
-----------------
|
|
||||||
|
|
||||||
Every project has a subdomain that is available to serve its documentation.
|
|
||||||
If you go to ``<organization-slug-project-slug>.readthedocs-hosted.com``,
|
|
||||||
it should show you the latest version of documentation.
|
|
||||||
|
|
||||||
|
|
||||||
CNAME Support
|
|
||||||
-------------
|
|
||||||
|
|
||||||
If you have your own domain, you can still host with us.
|
|
||||||
This requires two steps:
|
|
||||||
|
|
||||||
* Add a CNAME record in your DNS that points to our servers ``<organization-slug>.users.readthedocs.com``
|
|
||||||
* Add a Domain in the **Project Admin > Domains** page for your project.
|
|
||||||
|
|
||||||
.. note:: The Domain that should be used is the actual subdomain that you want your docs served on.
|
|
||||||
Generally it will be ``docs.projectname.com``.
|
|
||||||
|
|
||||||
CNAME SSL
|
|
||||||
---------
|
|
||||||
|
|
||||||
We do support SSL for CNAMEs on our side.
|
|
||||||
Please, `contact our support team`_ to setup it.
|
|
||||||
|
|
||||||
.. _contact our support team: mailto:support@readthedocs.com
|
|
|
@ -0,0 +1,36 @@
|
||||||
|
Custom Domains
|
||||||
|
==============
|
||||||
|
|
||||||
|
Subdomain support
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
Once a project is imported under Read the Docs,
|
||||||
|
by default it's hosted under a subdomain on one of our domains.
|
||||||
|
If you need a custom domain, continue on custom domain setup.
|
||||||
|
|
||||||
|
Custom domains
|
||||||
|
--------------
|
||||||
|
|
||||||
|
Projects can also be hosted under a custom domain.
|
||||||
|
If you'd prefer to use your own domain name instead of our default hosting domain,
|
||||||
|
you can still host with us.
|
||||||
|
|
||||||
|
|
||||||
|
We require two steps from your side:
|
||||||
|
|
||||||
|
* Add a CNAME record in your DNS that points to our servers ``<organization-slug>.users.readthedocs.com``
|
||||||
|
* Add a Domain in the **Project Admin > Domains** page for your project.
|
||||||
|
|
||||||
|
.. note:: The domain that should be used is the actual subdomain that you want your docs served on.
|
||||||
|
Generally it will be ``docs.projectname.com``.
|
||||||
|
|
||||||
|
|
||||||
|
Custom domain SSL
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
We do support SSL for CNAMEs on our side.
|
||||||
|
Please, `contact our support team`_ to setup it.
|
||||||
|
|
||||||
|
.. note:: SSL is required for *private* projects.
|
||||||
|
|
||||||
|
.. _contact our support team: mailto:support@readthedocs.com
|
|
@ -1,11 +1,11 @@
|
||||||
Read the Docs Business Features
|
Read the Docs Commercial Features
|
||||||
-------------------------------
|
---------------------------------
|
||||||
|
|
||||||
.. note:: These features are for our new business offering, `readthedocs.com`_.
|
.. note:: These features are for our new commercial offering, `readthedocs.com`_.
|
||||||
|
|
||||||
|
|
||||||
All of the other features outlined in these docs work on both sites.
|
All of the other features outlined in these docs work on both sites.
|
||||||
Things inside this section are specific to our business offering.
|
Things inside this section are specific to our commercial offering.
|
||||||
|
|
||||||
The largest feature that is different is that documentation on `readthedocs.com`_ is **private**.
|
The largest feature that is different is that documentation on `readthedocs.com`_ is **private**.
|
||||||
If you have private code that you want documentation for,
|
If you have private code that you want documentation for,
|
||||||
|
@ -15,7 +15,7 @@ this is our solution.
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
|
||||||
alternate_domains
|
custom_domains
|
||||||
organizations
|
organizations
|
||||||
sharing
|
sharing
|
||||||
analytics
|
analytics
|
|
@ -1,11 +1,11 @@
|
||||||
Alternate Domains
|
Custom Domains
|
||||||
=================
|
==============
|
||||||
|
|
||||||
.. note:: This documentation belongs to our community site.
|
.. note:: These setup directions are for our community site.
|
||||||
If you want to setup an Alternate Domain under `readthedocs.com`_,
|
If you want to setup a custom domain under our `commercial hosting`_,
|
||||||
please read our :ref:`business documentation <business/alternate_domains:Alternate Domains>`.
|
please read our :ref:`commercial documentation <commercial/custom_domains:Custom Domains>`.
|
||||||
|
|
||||||
.. _readthedocs.com: https://readthedocs.com
|
.. _commercial hosting: https://readthedocs.com
|
||||||
|
|
||||||
Read the Docs supports a number of custom domains for your convenience. Shorter URLs make everyone happy, and we like making people happy!
|
Read the Docs supports a number of custom domains for your convenience. Shorter URLs make everyone happy, and we like making people happy!
|
||||||
|
|
|
@ -127,13 +127,13 @@ to help you create fantastic documentation for your project.
|
||||||
design
|
design
|
||||||
RTD Theme <https://sphinx-rtd-theme.readthedocs.io/en/latest/>
|
RTD Theme <https://sphinx-rtd-theme.readthedocs.io/en/latest/>
|
||||||
|
|
||||||
.. _business-docs:
|
.. _commercial-docs:
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
:caption: Business Documentation
|
:caption: Commercial Documentation
|
||||||
|
|
||||||
business/index
|
commercial/index
|
||||||
|
|
||||||
.. _custom-docs:
|
.. _custom-docs:
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue