DOCSP-22785 disclaimer banner (#14)

Dave Cuthbert · web-flow · commit 04b4c6c553e6 · 2022-06-01T11:39:54.000-04:00
* DOCSP-22785 disclaimer banner * Review feedback * staging fixes * staging fixes * staging fixes * staging fixes * Review feedback
diff --git a/snooty.toml b/snooty.toml
@@ -17,3 +17,4 @@ c2c-full-product-name = "MongoDB Cluster-to-Cluster Sync"
 
 [substitutions]
 c2c-product-name = "Cluster-to-Cluster Sync"
+
diff --git a/source/connecting.txt b/source/connecting.txt
@@ -1,10 +1,11 @@
 .. _c2c-connecting:
 
-
 ========================
 Connecting ``mongosync``
 ========================
 
+.. include:: /includes/preview-warning
+ 
 .. toctree::
    :titlesonly: 
 
diff --git a/source/connecting/atlas-to-atlas.txt b/source/connecting/atlas-to-atlas.txt
@@ -4,6 +4,8 @@
 Connect Two Atlas Clusters
 ==========================
 
+.. include:: /includes/preview-warning
+
 .. default-domain:: mongodb
 
 Connect two Atlas clusters
diff --git a/source/connecting/onprem-onprem.txt b/source/connecting/onprem-onprem.txt
@@ -4,6 +4,8 @@
 Connect Two Self-Managed Clusters
 =================================
 
+.. include:: /includes/preview-warning
+
 .. default-domain:: mongodb
 
 self-managed to self-managed
diff --git a/source/connecting/onprem-to-atlas.txt b/source/connecting/onprem-to-atlas.txt
@@ -4,6 +4,8 @@
 Connect a Self-Managed Cluster to Atlas
 =======================================
 
+.. include:: /includes/preview-warning
+
 .. default-domain:: mongodb
 
 self-managed to atlas
diff --git a/source/faq.txt b/source/faq.txt
@@ -4,15 +4,22 @@
 Frequently Asked Questions
 ==========================
 
+.. include:: /includes/preview-warning
+
 .. default-domain:: mongodb
 
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
 
 This page provides answers to some frequently asked questions we have
 encountered. If you have additional questions please contact MongoDB
 Support.
 
 Does ``mongosync`` have to use the same operating system as MongoDB Enterprise Server? 
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+--------------------------------------------------------------------------------------
 
 When ``mongosync`` runs on its own hardware, it does not have to use
 the same operation system (OS) as the source or destination clusters it
@@ -21,7 +28,7 @@ is connecting.
 .. _c2c-faq-increase-oplog:
 
 Should I increase the size of the oplog in the source cluster?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+--------------------------------------------------------------
 
 If you anticipate synchronizing a large data set, or if you plan to
 pause synchronization for an extended period of time, increase the size
@@ -44,7 +51,7 @@ To learn more about how to increase the size of the ``oplog``, see:
 :ref:`tutorial-change-oplog-size`. 
 
 Which connection string options does ``mongosync`` allow?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+---------------------------------------------------------
 
 ``mongosync`` requires :ref:`readConcern: "majority" <read-concern>`
 and :ref:`writeConcern: "majority" <write-concern>`. ``mongosync`` 
@@ -56,7 +63,7 @@ overwrites any other ``readConcern`` or ``writeConcern`` and uses
 
 
 Which security and authentication options are supported?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+--------------------------------------------------------
 
 ``mongosync`` uses a standard MongoDB :ref:`connection string
 <mongodb-uri>` to connect to the source and destination clusters. 
@@ -67,7 +74,7 @@ authentication options, see :ref:`authentication`.
 
 
 Can I configure ``mongosync`` for high availability?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+----------------------------------------------------
 
 There is no automatic failover built into ``mongosync``. However you
 can write a script or use your operating system's process managers,
@@ -83,7 +90,7 @@ parameters. ``mongosync`` resumes the operation from where it stopped
 when ``mongosync`` became unavailable.
 
 Can the source or destination be a replica set with arbiters? 
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+-------------------------------------------------------------
 
 Yes, the replica set can have arbiters. The source replica set must
 have more than 2 non-arbiter nodes and you must sync from a non-arbiter
diff --git a/source/includes/preview-warning-body.rst b/source/includes/preview-warning-body.rst
@@ -0,0 +1,6 @@
+{+c2c-product-name+} is available as a Preview feature. This feature
+and the corresponding documentation may change at any time during
+the Preview phase.
+
+MongoDB does not support unreleased software. {+c2c-product-name+}
+should not be used in production systems.
diff --git a/source/includes/preview-warning.rst b/source/includes/preview-warning.rst
@@ -0,0 +1,3 @@
+.. note:: Preview Release
+
+   .. include:: /includes/preview-warning-body
diff --git a/source/index.txt b/source/index.txt
@@ -4,6 +4,8 @@
 Cluster-to-Cluster Sync
 =======================
 
+.. include:: /includes/preview-warning
+
 .. default-domain:: mongodb
 
 {+c2c-product-name+} provides you with continuous unidirectional
@@ -14,8 +16,8 @@ the :ref:`c2c-mongosync` utility tool.
 ``mongosync`` can continuously synchronize data between two clusters.
 You can use ``mongosync`` to create dedicated analytics, development,
 or testing clusters that mirror your production environment.
-Synchronized clusters can also support location requirements for audit
-and data residency compliance. 
+Synchronized clusters can support location requirements for audit and
+data residency compliance. 
 
 In addition to continuous data synchronization, ``mongosync`` can also
 facilitate a one time data migration between clusters. 
diff --git a/source/installation.txt b/source/installation.txt
@@ -1,11 +1,11 @@
-.. place holder for the installation section TOC
-
 .. _c2c-install:
 
 ============
 Installation
 ============
 
+.. include:: /includes/preview-warning
+
 .. contents:: On this page
    :local:
    :backlinks: none
diff --git a/source/installation/install-on-linux.txt b/source/installation/install-on-linux.txt
@@ -4,6 +4,8 @@
 Install on Linux
 ================
 
+.. include:: /includes/preview-warning
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/installation/install-on-macos.txt b/source/installation/install-on-macos.txt
@@ -4,6 +4,8 @@
 Install on macOS
 ================
 
+.. include:: /includes/preview-warning
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/quickstart.txt b/source/quickstart.txt
@@ -4,6 +4,8 @@
 Quick Start
 ===========
 
+.. include:: /includes/preview-warning
+
 .. default-domain:: mongodb
 
 Get going!
diff --git a/source/reference.txt b/source/reference.txt
@@ -7,6 +7,6 @@ Reference
 .. toctree::
    :titlesonly: 
 
-   /reference/api
    /reference/mongosync
-   
+   /reference/api
+
diff --git a/source/reference/api/start.txt b/source/reference/api/start.txt
@@ -4,6 +4,8 @@
 ``start``
 =========
 
+.. include:: /includes/preview-warning
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/reference/mongosync.txt b/source/reference/mongosync.txt
@@ -1,13 +1,15 @@
 .. _c2c-mongosync:
 
-.. default-domain:: mongodb
-
-.. program:: mongosync
-
 =============
 ``mongosync``
 =============
 
+.. include:: /includes/preview-warning
+
+.. default-domain:: mongodb
+
+.. program:: mongosync
+
 .. contents:: On this page
    :local:
    :backlinks: none
@@ -41,7 +43,7 @@ Global Options
 
 
    For more information on connecting ``mongosync``, see
-   :ref:`Connections <c2c-conn-top-level>`.
+   :ref:`Connections <c2c-connecting>`.
 
 
 .. option:: --cluster1 <URI>
@@ -56,7 +58,7 @@ Global Options
 
 
    For more information on connecting ``mongosync``, see
-   :ref:`Connections <c2c-conn-top-level>`.
+   :ref:`Connections <c2c-connecting>`.
 
 
 .. option:: --verbosity <level>
diff --git a/source/release-notes.txt b/source/release-notes.txt
@@ -4,6 +4,8 @@
 Release Notes
 =============
 
+.. include:: /includes/preview-warning
+
 .. toctree::
    :titlesonly: 
 
diff --git a/source/release-notes/0.9.txt b/source/release-notes/0.9.txt
@@ -12,8 +12,10 @@ Release Notes for ``mongosync`` 0.9
    :depth: 1
    :class: singlecol
 
-New Features
-------------
+.. _c2c-preview-release-notes:
 
-Cool new stuff goes here.
+Preview Software
+----------------
+
+.. include:: /includes/preview-warning-body
 
diff --git a/source/using-mongosync.txt b/source/using-mongosync.txt
@@ -6,6 +6,8 @@
 Using ``mongosync``
 ===================
 
+.. include:: /includes/preview-warning
+ 
 .. toctree::
    :titlesonly: 
 
diff --git a/source/using-mongosync/continuous-sync.txt b/source/using-mongosync/continuous-sync.txt
@@ -4,7 +4,10 @@
 Continuous Synchronization
 ==========================
 
+.. include:: /includes/preview-warning
+
 .. default-domain:: mongodb
 
+
 Continuous synch use case
 
diff --git a/source/using-mongosync/migration.txt b/source/using-mongosync/migration.txt
@@ -4,6 +4,8 @@
 Migrate Data to Another Cluster
 ===============================
 
+.. include:: /includes/preview-warning
+
 .. default-domain:: mongodb
 
 migration use case

Original file line number	Diff line number	Diff line change
`@@ -17,3 +17,4 @@ c2c-full-product-name = "MongoDB Cluster-to-Cluster Sync"`
`17`	`17`
`18`	`18`	`[substitutions]`
`19`	`19`	`c2c-product-name = "Cluster-to-Cluster Sync"`
	`20`	`+`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+.. note:: Preview Release`
	`2`	`+`
	`3`	`+ .. include:: /includes/preview-warning-body`