(DOCSP-28417): Add notes to single cluster docs with pointers to multi-cluster docs (#1293)

davidhou17 · web-flow · commit dfc4f2d37ffe · 2023-04-19T11:45:39.000-05:00
* Add pointers from single to multi cluster

* copy review feedback
diff --git a/source/includes/admonitions/note-single-to-multi-cluster.rst b/source/includes/admonitions/note-single-to-multi-cluster.rst
@@ -0,0 +1,4 @@
+.. important::
+
+   This section is for single |k8s| cluster deployments only. For
+   |multi-clusters|, see |multi-cluster-ref|.
diff --git a/source/kind-quick-start.txt b/source/kind-quick-start.txt
@@ -12,6 +12,10 @@ Quick Start
    :depth: 2
    :class: singlecol
 
+.. |multi-cluster-ref| replace:: :ref:`multi-cluster-quick-start-ref`
+
+.. include:: /includes/admonitions/note-single-to-multi-cluster.rst
+
 |k8s-op-full| uses the |k8s| API and tools to manage MongoDB
 clusters. |k8s-op-short| works together with MongoDB |com|. This 
 tutorial demonstrates how to deploy and connect to your first replica 
diff --git a/source/openshift-quick-start.txt b/source/openshift-quick-start.txt
@@ -12,6 +12,10 @@ OpenShift Quick Start
    :depth: 2
    :class: singlecol
 
+.. |multi-cluster-ref| replace:: :ref:`multi-cluster-quick-start-ref`
+
+.. include:: /includes/admonitions/note-single-to-multi-cluster.rst
+
 |k8s-op-full| uses the |k8s| API and tools to manage MongoDB
 clusters. |k8s-op-short| works together with MongoDB |com|. This 
 tutorial demonstrates how to deploy and connect to your first replica 
diff --git a/source/reference/troubleshooting.txt b/source/reference/troubleshooting.txt
@@ -12,6 +12,10 @@ Troubleshoot the |k8s-op-short|
    :depth: 1
    :class: singlecol
 
+.. |multi-cluster-ref| replace:: :ref:`multi-cluster-troubleshooting`
+
+.. include:: /includes/admonitions/note-single-to-multi-cluster.rst
+   
 .. _get-resource-status:
 
 Get Status of a Deployed Resource
diff --git a/source/tutorial/mdb-resources-arch.txt b/source/tutorial/mdb-resources-arch.txt
@@ -12,6 +12,10 @@ MongoDB Database Architecture in |k8s|
    :depth: 1
    :class: singlecol
 
+.. |multi-cluster-ref| replace:: :ref:`multi-cluster-arch-ref`
+
+.. include:: /includes/admonitions/note-single-to-multi-cluster.rst
+  
 You can use the |k8s-op-short| and |com| to deploy MongoDB database
 resources to a |k8s| cluster. You can use an existing |com|, or deploy
 |onprem| in |k8s| to manage your databases.
diff --git a/source/tutorial/om-arch.txt b/source/tutorial/om-arch.txt
@@ -12,6 +12,10 @@
    :depth: 1
    :class: singlecol
 
+.. |multi-cluster-ref| replace:: :ref:`multi-cluster-arch-ref`
+
+.. include:: /includes/admonitions/note-single-to-multi-cluster.rst
+
 You can use the |k8s-op-short| to deploy |onprem| and MongoDB resources
 to a |k8s| cluster. The |k8s-op-short| manages the lifecycle of each of
 these deployments differently.
diff --git a/source/tutorial/plan-k8s-op-architecture.txt b/source/tutorial/plan-k8s-op-architecture.txt
@@ -12,6 +12,10 @@
    :depth: 1
    :class: singlecol
 
+.. |multi-cluster-ref| replace:: :ref:`multi-cluster-arch-ref`
+
+.. include:: /includes/admonitions/note-single-to-multi-cluster.rst
+
 The |k8s-op| provides a container image for the {+mdbagent+} in |onprem|. This
 allows you to manage and deploy MongoDB database clusters with full monitoring,
 backups, and automation provided by |onprem|.
diff --git a/source/tutorial/plan-k8s-operator-install.txt b/source/tutorial/plan-k8s-operator-install.txt
@@ -12,6 +12,10 @@ Plan your |k8s-op-full| Installation
    :depth: 1
    :class: singlecol
 
+.. |multi-cluster-ref| replace:: :ref:`multi-cluster-overview-ref`
+
+.. include:: /includes/admonitions/note-single-to-multi-cluster.rst
+
 Use the |k8s-op-full| to deploy:
 
 - Ops Manager resources
