Merge pull request #4271 from rtfd/humitos/docs/alternate-domains-bus…

…iness Document alternate domains for business site
readthedocs · Nov 1, 2018 · acc8ef2 · acc8ef2
2 parents 897bc11 + 57177e7
commit acc8ef2
Show file tree

Hide file tree

Showing 7 changed files with 54 additions and 10 deletions.
diff --git a/docs/business/analytics.rst → docs/commercial/analytics.rst b/docs/business/analytics.rst → docs/commercial/analytics.rst
diff --git a/docs/commercial/custom_domains.rst b/docs/commercial/custom_domains.rst
@@ -0,0 +1,37 @@
+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``
+* Set your project's Privacy Level to *Public* from **Project Admin > Advance Settings**.
+* 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
diff --git a/docs/business/index.rst → docs/commercial/index.rst b/docs/business/index.rst → docs/commercial/index.rst
@@ -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.
-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**.
 If you have private code that you want documentation for,
@@ -15,6 +15,7 @@ this is our solution.
 
 .. toctree:: 
 
+   custom_domains
    organizations
    sharing
    analytics
diff --git a/docs/business/organizations.rst → docs/commercial/organizations.rst b/docs/business/organizations.rst → docs/commercial/organizations.rst
diff --git a/docs/business/sharing.rst → docs/commercial/sharing.rst b/docs/business/sharing.rst → docs/commercial/sharing.rst
diff --git a/docs/alternate_domains.rst → docs/custom_domains.rst b/docs/alternate_domains.rst → docs/custom_domains.rst
@@ -1,12 +1,18 @@
-Alternate Domains
-=================
+Custom Domains
+==============
+
+.. note:: These setup directions are for our community site.
+          If you want to setup a custom domain under our `commercial hosting`_,
+          please read our :ref:`commercial documentation <commercial/custom_domains:Custom Domains>`.
+
+.. _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!
 
 Subdomain Support
 ------------------
 
-Every project has a subdomain that is available to serve its documentation. If you go to <slug>.readthedocs.io, it should show you the latest version of documentation. A good example is https://pip.readthedocs.io
+Every project has a subdomain that is available to serve its documentation. If you go to ``<slug>.readthedocs.io``, it should show you the latest version of documentation. A good example is https://pip.readthedocs.io
 
 .. note:: If you have an old project that has an underscore (_) in the name, it will use a subdomain with a hyphen (-).
           `RFC 1035 <http://tools.ietf.org/html/rfc1035>`_ has more information on valid subdomains.

diff --git a/docs/index.rst b/docs/index.rst
@@ -127,13 +127,13 @@ to help you create fantastic documentation for your project.
    design
    RTD Theme <https://sphinx-rtd-theme.readthedocs.io/en/latest/>
 
-.. _business-docs:
+.. _commercial-docs:
 
 .. toctree::
    :maxdepth: 2
-   :caption: Business Documentation
+   :caption: Commercial Documentation
 
-   business/index
+   commercial/index
 
 .. _custom-docs: