From a07efcb34780bd5ad343e88933a16b5e5fa36ade Mon Sep 17 00:00:00 2001 From: Lauren Tran Date: Wed, 28 Feb 2024 11:14:54 -0800 Subject: [PATCH 1/6] DOCSP-23924 reformatting quickstart --- source/quickstart.txt | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/source/quickstart.txt b/source/quickstart.txt index ccb648338..fb743a827 100644 --- a/source/quickstart.txt +++ b/source/quickstart.txt @@ -142,7 +142,13 @@ Follow the instructions below to set up {+c2c-product-name+}. For operating system specific installation instructions, see :ref:`c2c-install`. - .. step:: Connect the Clusters +Connect Your Clusters +--------------------- + +.. procedure:: + :style: normal + + .. step:: Format Your Connection String A connection string contains the network and authentication details that ``mongosync`` needs to connect to the source and @@ -169,20 +175,20 @@ Follow the instructions below to set up {+c2c-product-name+}. For more details, see :ref:`c2c-connecting`. -Initialize ``mongosync`` ------------------------- + .. step:: Initialize mongosync -:program:`mongosync` must create an initial connection to the source and -destination clusters before it can start to sync data. To create the initial -connection, issue the following command on a single line (the command is -reformatted here for clarity): + :program:`mongosync` must create an initial connection to the source and + destination clusters before it can start to sync data. To create the initial + connection, issue the following command with your connection + strings on a single line (the command is + reformatted here for clarity): -.. code-block:: shell + .. code-block:: shell - ./bin/mongosync \ - --logPath /var/log/mongosync \ - --cluster0 "mongodb://clusterAdmin:superSecret@clusterOne01.fancyCorp.com:20020,clusterOne02.fancyCorp.com:20020,clusterOne03.fancyCorp.com:20020" \ - --cluster1 "mongodb://clusterAdmin:superSecret@clusterTwo01.fancyCorp.com:20020,clusterTwo02.fancyCorp.com:20020,clusterTwo03.fancyCorp.com:20020" + ./bin/mongosync \ + --logPath /var/log/mongosync \ + --cluster0 "mongodb://clusterAdmin:superSecret@clusterOne01.fancyCorp.com:20020,clusterOne02.fancyCorp.com:20020,clusterOne03.fancyCorp.com:20020" \ + --cluster1 "mongodb://clusterAdmin:superSecret@clusterTwo01.fancyCorp.com:20020,clusterTwo02.fancyCorp.com:20020,clusterTwo03.fancyCorp.com:20020" Initialization Notes ~~~~~~~~~~~~~~~~~~~~ From 68f60e8fe0b5e115350a23d5d4a6013a6840b5a5 Mon Sep 17 00:00:00 2001 From: Lauren Tran Date: Wed, 28 Feb 2024 11:19:18 -0800 Subject: [PATCH 2/6] DOCSP-23924 reformatting quickstart --- source/quickstart.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/quickstart.txt b/source/quickstart.txt index fb743a827..f6f586e1f 100644 --- a/source/quickstart.txt +++ b/source/quickstart.txt @@ -142,13 +142,13 @@ Follow the instructions below to set up {+c2c-product-name+}. For operating system specific installation instructions, see :ref:`c2c-install`. -Connect Your Clusters +Connect your Clusters --------------------- .. procedure:: :style: normal - .. step:: Format Your Connection String + .. step:: Format your connection strings A connection string contains the network and authentication details that ``mongosync`` needs to connect to the source and From e254cff22970ca6a4fa7e2bd18ca0677d52e4e12 Mon Sep 17 00:00:00 2001 From: Lauren Tran Date: Wed, 28 Feb 2024 11:23:47 -0800 Subject: [PATCH 3/6] DOCSP-23924 reformatting quickstart --- source/quickstart.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/quickstart.txt b/source/quickstart.txt index f6f586e1f..9085a78e2 100644 --- a/source/quickstart.txt +++ b/source/quickstart.txt @@ -142,8 +142,8 @@ Follow the instructions below to set up {+c2c-product-name+}. For operating system specific installation instructions, see :ref:`c2c-install`. -Connect your Clusters ---------------------- +Connect the Clusters +-------------------- .. procedure:: :style: normal From 2b61cca436d41c6a87dc5a4702f24f405d5d3809 Mon Sep 17 00:00:00 2001 From: Lauren Tran Date: Wed, 28 Feb 2024 16:42:45 -0800 Subject: [PATCH 4/6] DOCSP-23924 remove list and add clarification --- source/quickstart.txt | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/source/quickstart.txt b/source/quickstart.txt index 9085a78e2..5d4bab39b 100644 --- a/source/quickstart.txt +++ b/source/quickstart.txt @@ -41,14 +41,8 @@ Setup meets the minimum patch :ref:`version requirements `. -To run ``mongosync``, you need to: - -#. Define a source and a destination cluster. -#. Define administrative users. -#. Download and install ``mongosync``. -#. Connect the clusters. - -Follow the instructions below to set up {+c2c-product-name+}. +Follow the instructions below to set up {+c2c-product-name+}, connect +your clusters, and synchronize your data. .. procedure:: :style: normal From e337309926ea9a6e30f6684318a640a364d528b4 Mon Sep 17 00:00:00 2001 From: Lauren Tran Date: Wed, 28 Feb 2024 16:44:09 -0800 Subject: [PATCH 5/6] DOCSP-23924 remove list and add clarification --- source/quickstart.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/quickstart.txt b/source/quickstart.txt index 5d4bab39b..472f93dc4 100644 --- a/source/quickstart.txt +++ b/source/quickstart.txt @@ -25,6 +25,9 @@ to synchronize data between them. The tool that makes the connection is you get started with {+c2c-product-name+}. For more details, please see the rest of the {+c2c-product-name+} documentation. +Follow the instructions below to set up {+c2c-product-name+}, connect +your clusters, and synchronize your data. + Setup ----- @@ -41,9 +44,6 @@ Setup meets the minimum patch :ref:`version requirements `. -Follow the instructions below to set up {+c2c-product-name+}, connect -your clusters, and synchronize your data. - .. procedure:: :style: normal From 6723ae6f59391f23c6d483ea3c84981a79877bc1 Mon Sep 17 00:00:00 2001 From: Lauren Tran Date: Wed, 28 Feb 2024 16:45:32 -0800 Subject: [PATCH 6/6] DOCSP-23924 remove list and add clarification --- source/quickstart.txt | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/source/quickstart.txt b/source/quickstart.txt index 472f93dc4..2ce48691f 100644 --- a/source/quickstart.txt +++ b/source/quickstart.txt @@ -25,12 +25,6 @@ to synchronize data between them. The tool that makes the connection is you get started with {+c2c-product-name+}. For more details, please see the rest of the {+c2c-product-name+} documentation. -Follow the instructions below to set up {+c2c-product-name+}, connect -your clusters, and synchronize your data. - -Setup ------ - ``mongosync`` syncs data between two clusters. - Each cluster can be a replica set or a sharded cluster. If either @@ -44,6 +38,12 @@ Setup meets the minimum patch :ref:`version requirements `. +Follow the instructions below to set up {+c2c-product-name+}, connect +your clusters, and synchronize your data. + +Setup +----- + .. procedure:: :style: normal