Skip to content

Commit 5a7f521

Browse files
author
Dave Cuthbert
authored
DOCSP-23092 create windows install page (#33)
* DOCSP-23092 create windows install page * DOCSP-23092 create windows install page * Staging fixes * Review feedback * Staging
1 parent cc19cb2 commit 5a7f521

File tree

8 files changed

+124
-19
lines changed

8 files changed

+124
-19
lines changed

‎snooty.toml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ toc_landing_pages = ["/quickstart",
2626
version = "0.9.0"
2727
c2c-product-name = "Cluster-to-Cluster Sync"
2828
c2c-full-product-name = "MongoDB Cluster-to-Cluster Sync"
29+
mdb-download-center = "`MongoDB Download Center <https://www.mongodb.com/try/download/enterprise?tck=docs_server>`__"
2930

3031
[substitutions]
3132
c2c-product-name = "Cluster-to-Cluster Sync"

‎source/connecting/atlas-to-atlas.txt‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,6 @@ Connection Strings
2626

2727
.. include:: /includes/fact-connection-strings
2828

29-
.. include:: /includes/fact-connect-sharded
30-
3129
Authentication
3230
--------------
3331

‎source/includes/fact-install-past-mongosync.rst‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1 @@
1-
2-
This tutorial installs {+c2c-full-product-name+} {+version+}. To
3-
install a different version of {+c2c-product-name+}, use the version
4-
drop-down menu in the upper-left corner of this page to select the
5-
documentation for that version.
1+
This tutorial installs {+c2c-full-product-name+} {+version+}.

‎source/includes/step-update-path-windows.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
The ``mongosync`` binary is in the ``bin/`` directory of the
2+
extracted ZIP file. To add the location of the ``mongosync`` binary to
3+
your ``PATH``, do one of the following:
4+
5+
- Copy the binary into a directory listed in your ``PATH``.
6+
7+
- Add the ``bin`` directory to your ``PATH``. To update the ``PATH``,
8+
replace ``<path-to-bin>`` with the actual path and execute the
9+
following command in a ``cmd`` shell:
10+
11+
.. code-block:: bash
12+
13+
pathman /au` <path-to-bin>
14+

‎source/installation.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,13 @@ These documents provide instructions to install {+c2c-full-product-name+}.
2020
:ref:`c2c-install-macos`
2121
Install the official build of {+c2c-product-name+} on macOS.
2222

23+
:ref:`c2c-install-windows`
24+
Install the official build of {+c2c-product-name+} on Windows.
25+
2326
.. toctree::
2427
:hidden:
2528

2629
/installation/install-on-linux
2730
/installation/install-on-macos
31+
/installation/install-on-windows
2832

‎source/installation/install-on-linux.txt‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,12 @@ Install on Linux
1616

1717
.. |arrow| unicode:: U+27A4
1818
.. |executable-name| replace:: ``mongosync``
19-
.. |mdb-download-link| replace:: `MongoDB Download Center <https://www.mongodb.com/try/download/enterprise?tck=docs_server>`__
2019

2120
Overview
2221
--------
2322

24-
Use this tutorial to manually install {+c2c-full-product-name+}
25-
{+version+} on Linux using a downloaded ``.tgz`` tarball.
23+
To configure {+c2c-full-product-name+} on Linux using a downloaded
24+
``.tgz`` tarball, follow the steps on this page.
2625

2726
{+c2c-product-name+} is available on select platforms.
2827

@@ -36,14 +35,13 @@ Use this tutorial to manually install {+c2c-full-product-name+}
3635
Considerations
3736
--------------
3837

39-
Consider the following when running {+c2c-full-product-name+} on Linux:
40-
4138
Platform Support
4239
~~~~~~~~~~~~~~~~
4340

4441
{+c2c-product-name+} is available on the following Linux operating
4542
systems:
4643

44+
- Amazon Linux 2
4745
- Red Hat Enterprise Linux (RHEL) 7
4846
- Red Hat Enterprise Linux (RHEL) 8
4947
- Ubuntu 18.04
@@ -70,7 +68,7 @@ the ``.tgz``.
7068
Download the {+c2c-product-name+} ``.tgz`` tarball from the
7169
following link:
7270

73-
|arrow| |mdb-download-link|
71+
|arrow| {+mdb-download-center+}
7472

7573
a. In the :guilabel:`Version` dropdown, select the version of
7674
{+c2c-product-name+} to download.

‎source/installation/install-on-macos.txt‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,12 @@ Install on macOS
1919
.. |distro-name| replace:: macOS
2020
.. |package-manager| replace:: ``brew``
2121
.. |executable-name| replace:: ``mongod``
22-
.. |mdb-download-link| replace:: `MongoDB Download Center <https://www.mongodb.com/try/download/enterprise?tck=docs_server>`__
2322

2423
Overview
2524
--------
2625

27-
Use this tutorial to manually install {+c2c-full-product-name+}
28-
{+version+} on macOS using a downloaded ``.tgz`` tarball.
26+
To configure {+c2c-full-product-name+} on macOS using a downloaded
27+
``.tgz`` tarball, follow the steps on this page.
2928

3029
.. bug in constant parser DOP-3025
3130

@@ -37,8 +36,6 @@ Use this tutorial to manually install {+c2c-full-product-name+}
3736
Considerations
3837
--------------
3938

40-
Consider the following when running {+c2c-product-name+} on macOS:
41-
4239
Platform Support
4340
~~~~~~~~~~~~~~~~
4441

@@ -65,7 +62,7 @@ the ``.tgz``.
6562
Download the {+c2c-product-name+} ``.tgz`` tarball from the following
6663
link:
6764

68-
|arrow| |mdb-download-link|
65+
|arrow| {+mdb-download-center+}
6966

7067
a. In the :guilabel:`Version` dropdown, select the version of
7168
{+c2c-product-name+} to download.

‎source/installation/install-on-windows.txt‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
.. _c2c-install-windows:
2+
3+
==================
4+
Install on Windows
5+
==================
6+
7+
.. include:: /includes/preview-warning
8+
9+
.. default-domain:: mongodb
10+
11+
.. contents:: On this page
12+
:local:
13+
:backlinks: none
14+
:depth: 1
15+
:class: twocols
16+
17+
.. |arrow| unicode:: U+27A4
18+
19+
Overview
20+
--------
21+
22+
To configure {+c2c-full-product-name+} on Windows using a downloaded
23+
ZIP file follow the steps on this page.
24+
25+
.. bug in constant parser DOP-3025
26+
27+
{+c2c-product-name+} Version
28+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
29+
30+
.. include:: /includes/fact-install-past-mongosync.rst
31+
32+
Considerations
33+
--------------
34+
35+
Platform Support
36+
~~~~~~~~~~~~~~~~
37+
38+
{+c2c-product-name+} is available on the following Windows operating
39+
systems:
40+
41+
- Windows 10
42+
- Windows 11
43+
44+
Version Requirements
45+
~~~~~~~~~~~~~~~~~~~~
46+
47+
.. include:: /includes/fact-mongodb-version.rst
48+
49+
.. bug in constant parser DOP-3025
50+
51+
Install {+c2c-product-name+}
52+
-------------------------------
53+
54+
Follow these steps to manually install {+c2c-product-name+} from
55+
the ZIP file.
56+
57+
.. procedure::
58+
:style: normal
59+
60+
.. step:: Download the ZIP file.
61+
62+
Download the {+c2c-product-name+} ZIP file from the MongoDB
63+
Download Center.
64+
65+
|arrow| {+mdb-download-center+}
66+
67+
a. In the :guilabel:`Version` dropdown, select the version of
68+
{+c2c-product-name+} to download.
69+
70+
#. In the :guilabel:`Platform` dropdown, select
71+
:guilabel:`Windows`.
72+
73+
#. In the :guilabel:`Package` dropdown, select
74+
:guilabel:`zip`.
75+
76+
#. Click :guilabel:`Download`.
77+
78+
.. step:: Extract the files from the downloaded archive.
79+
80+
Windows 10 builds after 17062 include the ``tar.exe`` command.
81+
To extract ``mongosync``, use the ``tar`` command in a system
82+
shell:
83+
84+
.. code-block:: bash
85+
86+
tar -xf mongosync-*.zip
87+
88+
.. step:: Ensure the binary is in a directory listed in your ``PATH`` environment variable.
89+
90+
.. include:: /includes/step-update-path-windows.rst
91+
92+
.. bug in constant parser DOP-3025
93+
94+
Run {+c2c-product-name+}
95+
---------------------------
96+
97+
.. include:: /includes/run-c2c.rst

0 commit comments

Comments
 (0)