Merge pull request #31 from mailsac/rename_private_domain_to_custom_d…

…omain

Rename private domain to custom domain

Makefile

@@ -2,7 +2,7 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    =
+SPHINXOPTS    = -E
 SPHINXBUILD   = sphinx-build
 SPHINXPROJ    = mailsac-examples
 SOURCEDIR     = .
@@ -17,4 +17,4 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

index.rst

@@ -1,7 +1,7 @@
 .. mailsac-examples documentation master file, created by Forking Software LLC
 
 Mailsac Docs
-============================================
+============
 
 Welcome to the official documentation for Mailsac, the disposable email 
 service built for developers.
@@ -54,7 +54,7 @@ Table of Contents
    services/sending_mail/sendingmail
    services/mailredirect
    services/slack_webhook/slack_webhook
-   services/private_domains/private_domains
+   services/custom_domains/custom_domains
    services/private_addresses/private_addresses
    services/email_validation/email_validation
 

services/private_domains/private_domains.rst → services/custom_domains/custom_domains.rst

@@ -1,10 +1,18 @@
-.. _doc_privatedomains:
+.. _Dashboard: https://mailsac.com/dashboard
+.. _`Verified Domains`: https://mailsac.com/domains
+.. _amazon_dns: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resource-record-sets-creating.html
+.. _cloudflare_dns: https://support.cloudflare.com/hc/en-us/articles/360019093151
+.. _namecheap_dns: https://www.namecheap.com/support/knowledgebase/article.aspx/317/2237/how-do-i-add-txtspfdkimdmarc-records-for-my-domain
+.. _names_co_uk_dns: https://www.names.co.uk/support/1156-changing_your_domains_dns_settings.html
+.. _wix_dns: https://support.wix.com/en/article/adding-or-updating-spf-records-in-your-wix-account
 
-Private Domains
-===============
+.. _doc_custom_domains:
 
-Private domains allow for receiving of email at any address within a
-domain. Private domains can be `purchased <https://mailsac.com/pricing>`_ as
+Custom Domains
+==============
+
+Custom domains allow for receiving of email at any address within a
+domain. Custom domains can be `purchased <https://mailsac.com/pricing>`_ as
 an addon or as part of a plan.
 
 Zero-Setup Subdomain
@@ -31,12 +39,11 @@ registrar (`Namecheap <https://namecheap.com>`__ or
 .. _section_zero_setup_subdomain:
 
 Zero-Setup Subdomain Configuration
-==================================
+----------------------------------
 
 Setting up a Zero-Setup domain only takes a few seconds.
 
-#. From the `dashboard <https://mailsac.com/dashboard>`_, select `Verified
-   Domains <https://mailsac.com/domains>`_.
+#. From the Dashboard_, select `Verified Domains`_.
 
    .. image:: verified_domains.png
       :scale: 50%
@@ -54,7 +61,7 @@ Setting up a Zero-Setup domain only takes a few seconds.
       :width: 600px
       :align: center
 
-#. Send a test email to any address at in the private domain. There is no
+#. Send a test email to any address at in the custom domain. There is no
    need to configure individual addresses. Sending an email to the address
    creates the address.
 
@@ -73,13 +80,12 @@ Setting up a Zero-Setup domain only takes a few seconds.
 .. _section_byod_configuration:
 
 BYODomain Configuration
-=======================
+-----------------------
 
 BYODomain configuration requires you to have access to modify DNS records on
 your domain.
 
-#. From the `dashboard <https://mailsac.com/dashboard>`_, select `Verified
-   Domains <https://mailsac.com/domains>`_.
+#. From the Dashboard_, select `Verified Domains`_.
 
    .. image:: verified_domains.png
       :width: 250px
@@ -110,7 +116,7 @@ your domain.
 
    Create a TXT record for DKIM with the hostname and value found on the DNS
    Setup page
-   in the Mailsac dashboard.
+   in the Mailsac Dashboard_.
 
    .. image:: byod_dkim.png
       :width: 600px
@@ -125,20 +131,20 @@ your domain.
   =============== ==================
   DNS Provider    Documentation Link
   =============== ==================
-  Amazon Route 53 `Creating Records Using the Amazon Route 53 Console <https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resource-record-sets-creating.html>`_
+  Amazon Route 53 `Creating Records Using the Amazon Route 53 Console <amazon_dns_>`_
   GoDaddy         `Add a TXT record <https://www.godaddy.com/help/add-a-txt-record-19232>`_
   Dreamhost       `How do I add custom DNS records <https://help.dreamhost.com/hc/en-us/articles/215414867-How-do-I-add-custom-DNS-records->`_
-  Cloudflare      `Managing DNS records in CloudFlare <https://support.cloudflare.com/hc/en-us/articles/360019093151>`_
+  Cloudflare      `Managing DNS records in CloudFlare <cloudflare_dns_>`_
   HostGator       `Manage DNS records <https://www.hostgator.com/help/article/manage-dns-records-with-hostgatorenom>`_
-  Namecheap       `How do I add TXT/SPF/DKIM/DMARC records for my domain <https://www.namecheap.com/support/knowledgebase/article.aspx/317/2237/how-do-i-add-txtspfdkimdmarc-records-for-my-domain>`_
-  Names.co.uk     `Changing your domain's DNS settings <https://www.names.co.uk/support/1156-changing_your_domains_dns_settings.html>`_
-  Wix             `Adding or updating TXT Records in Your Wix account <https://support.wix.com/en/article/adding-or-updating-txt-records-in-your-wix-account>`_
+  Namecheap       `How do I add TXT/SPF/DKIM/DMARC records for my domain <namecheap_dns_>`_
+  Names.co.uk     `Changing your domain's DNS settings <names_co_uk_dns_>`_
+  Wix             `Adding or updating TXT Records in Your Wix account <wix_dns_>`_
   =============== ==================
 
 #. Configure TXT DNS record for SPF
 
    Create a TXT record for SPF with the hostname and value found on the DNS
-   Setup page in the Mailsac dashboard.
+   Setup page in the Mailsac Dashboard_.
 
    .. image:: byod_spf.png
       :width: 600px
@@ -147,20 +153,20 @@ your domain.
   =============== ==================
   DNS Provider    Documentation Link
   =============== ==================
-  Amazon Route 53 `Creating Records Using the Amazon Route 53 Console <https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resource-record-sets-creating.html>`_
+  Amazon Route 53 `Creating Records Using the Amazon Route 53 Console <amazon_dns_>`_
   GoDaddy         `Adding an SPF record <https://www.godaddy.com/help/add-an-spf-record-19218>`_
   Dreamhost       `How do I add an SPF record <https://help.dreamhost.com/hc/en-us/articles/216106197-How-do-I-add-an-SPF-record->`_
-  Cloudflare      `Managing DNS records in CloudFlare <https://support.cloudflare.com/hc/en-us/articles/360019093151>`_
+  Cloudflare      `Managing DNS records in CloudFlare <cloudflare_dns_>`_
   HostGator       `SPF Records <https://www.hostgator.com/help/article/spf-records>`_
-  Namecheap       `How do I add TXT/SPF/DKIM/DMARC records for my domain <https://www.namecheap.com/support/knowledgebase/article.aspx/317/2237/how-do-i-add-txtspfdkimdmarc-records-for-my-domain>`_
-  Names.co.uk     `Changing your domain's DNS settings <https://www.names.co.uk/support/1156-changing_your_domains_dns_settings.html>`_
-  Wix             `Adding or updating SPF Records in Your Wix account <https://support.wix.com/en/article/adding-or-updating-spf-records-in-your-wix-account>`_
+  Namecheap       `How do I add TXT/SPF/DKIM/DMARC records for my domain <namecheap_dns_>`_
+  Names.co.uk     `Changing your domain's DNS settings <names_co_uk_dns_>`_
+  Wix             `Adding or updating TXT Records in Your Wix account <wix_dns_>`_
   =============== ==================
 
 #. Configure MX records to receive mail
 
    Create two MX records to receive mail with the hostname and value found on
-   the DNS Setup page in the Mailsac dashboard.
+   the DNS Setup page in the Mailsac Dashboard_.
 
    .. image:: byod_mx.png
       :width: 600px

services/email_hosting.rst

@@ -25,4 +25,4 @@ Common DNS Provider Links
 -------------------------
 
 .. rst-class:: blockquote-noleftmargin
-.. include:: ./private_domains/mx_record_links.rst
+.. include:: ./custom_domains/mx_record_links.rst

services/introduction.rst

@@ -15,4 +15,4 @@ the services provided:
 * :ref:`Sending Mail <doc_sendingmail>`
 * :ref:`Alternate Address Redirect <doc_mailredirect>`
 * :ref:`Receive Pushed Email via WebSocket <doc_websocket_example_overview>`
-* :ref:`Private Domains <doc_privatedomains>`
+* :ref:`Private Domains <doc_custom_domains>`

services/mailstorage.rst

@@ -9,7 +9,7 @@ All `plans <https://mailsac.com/pricing>`_ include message storage. The amount
 of message storage is how many messages can be stored before mail before
 messages are recycled.
 
-Messages that are sent to a :ref:`private domain <doc_privatedomains>`, private 
+Messages that are sent to a :ref:`private domain <doc_custom_domains>`, private 
 address, or `starred messages`_ count towards message storage.
 
 When are Messages Recycled?
@@ -18,7 +18,7 @@ When are Messages Recycled?
 Messages sent to non-private addresses and domains will be recycled at times
 to ensure capacity for new messages.
 
-Messages sent to :ref:`private domains <doc_privatedomains>`, private addresses,
+Messages sent to :ref:`private domains <doc_custom_domains>`, private addresses,
 and `starred messages`_ associated with Mailsac are recycled once the storage 
 limit is reached.