Skip to content

Commit e3b10c4

Browse files
jeff-allen-mongojeff-allen-mongo
authored
(DOCSP-11649): Update install instructions for .deb and .rpm (#56)
* (DOCSP-11649): Update install instructions for .deb and .rpm * Updates per copy review * Updates per review
1 parent 8e6ea83 commit e3b10c4

8 files changed

+94
-44
lines changed

‎snooty.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ toc_landing_pages = ["/run-commands", "/crud"]
77

88
[constants]
99

10+
version = "0.4.0"
11+
1012
[substitutions]
1113

1214
2fa = ":abbr:`2FA (Two Factor Authentication)`"

‎source/includes/steps-install-shell-base.yaml

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,28 @@
11
---
2-
title: "Navigate to the MongoDB Download Center."
2+
title: "Open the MongoDB Shell download page."
33
ref: navigate-dlc
44
level: 4
55
content: |
66
77
Open the `MongoDB Download Center
8-
<https://www.mongodb.com/download-center/community?jmp=docs>`__.
8+
<https://www.mongodb.com/try/download/shell?jmp=docs>`__.
99
---
10-
title: "Open the |mdb-shell| Download Page."
11-
ref: open-mdb-shell-page
12-
level: 4
13-
content: |
14-
15-
Click :guilabel:`Tools`, then select :guilabel:`Shell`.
16-
---
17-
title: "Download the installation archive for your operating system."
10+
title: "Download the ``mongosh`` installation archive for your
11+
operating system."
1812
ref: download-archive
1913
level: 4
2014
---
2115
title: "Extract the files from the downloaded archive."
2216
ref: extract-archive
2317
level: 4
2418
content: |
19+
20+
Run the following command from the directory containing the
21+
``mongosh`` ``.tgz`` package:
2522
2623
.. code-block:: sh
2724
28-
tar -zxvf path/to/archive
25+
tar -zxvf mongosh-{+version+}-linux.tgz
2926
3027
If your web browser automatically extracts the archive as
3128
part of the download or you extract the archive without the
@@ -34,7 +31,7 @@ content: |
3431
3532
.. code-block:: sh
3633
37-
chmod +x /path/to/mongosh
34+
chmod +x mongosh
3835
---
3936
title: "Add the ``mongosh`` binary to your ``PATH`` environment
4037
variable."
@@ -44,21 +41,20 @@ content: |
4441
4542
You can either:
4643
47-
- Copy the ``mongosh`` binary into a directory listed in your ``PATH``
48-
variable, such as ``/usr/local/bin`` (Update
49-
``/path/to/mongosh`` with your installation directory as
50-
appropriate)
44+
- Copy the ``mongosh`` binary into a directory listed in your
45+
``PATH`` variable, such as ``/usr/local/bin``. Run the following
46+
command from the directory containing the ``mongosh`` binary:
5147
5248
.. code-block:: sh
5349
54-
sudo cp /path/to/mongosh /usr/local/bin/
50+
sudo cp mongosh /usr/local/bin/
5551
5652
- Create a symbolic link to the ``mongosh`` binary from a directory
57-
listed in your ``PATH`` variable, such as ``/usr/local/bin``
58-
(Update ``/path/to/mongosh`` with your installation directory as
59-
appropriate):
53+
listed in your ``PATH`` variable, such as ``/usr/local/bin``.
54+
Run the following command from the directory containing the
55+
``mongosh`` binary:
6056
6157
.. code-block:: sh
6258
63-
sudo ln -s /path/to/mongosh /usr/local/bin/
59+
sudo ln -s mongosh /usr/local/bin/
6460
...

‎source/includes/steps-install-shell-linux-deb.yaml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
source:
3+
file: steps-install-shell-base.yaml
4+
ref: navigate-dlc
5+
ref: navigate-dlc-linux-deb
6+
---
7+
title: "Download the Debian 64-bit ``.deb`` package."
8+
ref: download-archive-rhel
9+
level: 4
10+
---
11+
title: "Extract and install the ``.deb`` package."
12+
ref: extract-archive-linux-deb
13+
level: 4
14+
content: |
15+
To install the |mdb-shell|, run the following command from the
16+
directory containing the ``mongosh`` ``.deb`` package:
17+
18+
.. code-block:: sh
19+
20+
sudo dpkg --install mongosh_{+version+}_amd64.deb
21+
...

‎source/includes/steps-install-shell-generic-linux.yaml renamed to ‎source/includes/steps-install-shell-linux-generic.yaml

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,9 @@ source:
44
ref: navigate-dlc
55
ref: navigate-dlc-generic-linux
66
---
7-
source:
8-
file: steps-install-shell-base.yaml
9-
ref: open-mdb-shell-page
10-
ref: open-mdb-shell-page-generic-linux
11-
---
12-
source:
13-
file: steps-install-shell-base.yaml
14-
ref: download-archive
15-
ref: download-archive-generic-linux
7+
title: "Download the Linux 64-bit ``.tgz`` package."
8+
ref: download-archive-rhel
9+
level: 4
1610
---
1711
source:
1812
file: steps-install-shell-base.yaml
@@ -23,5 +17,4 @@ source:
2317
file: steps-install-shell-base.yaml
2418
ref: add-shell-to-path
2519
ref: add-shell-to-path-generic-linux
26-
2720
...

‎source/includes/steps-install-shell-linux-rpm.yaml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
source:
3+
file: steps-install-shell-base.yaml
4+
ref: navigate-dlc
5+
ref: navigate-dlc-linux-rpm
6+
---
7+
title: "Download the Red Hat 64-bit ``.rpm`` package."
8+
ref: download-archive-rhel
9+
level: 4
10+
---
11+
title: "Extract and install the ``.rpm`` package."
12+
ref: extract-archive-rpm
13+
level: 4
14+
content: |
15+
To install the |mdb-shell|, run the following command from the
16+
directory containing the ``mongosh`` ``.rpm`` package:
17+
18+
.. code-block:: sh
19+
20+
sudo yum install -y mongosh-{+version+}-x86_64.rpm
21+
...

‎source/includes/steps-install-shell-macos.yaml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,6 @@ source:
44
ref: navigate-dlc
55
ref: navigate-dlc-macos
66
---
7-
source:
8-
file: steps-install-shell-base.yaml
9-
ref: open-mdb-shell-page
10-
ref: open-mdb-shell-page-macos
11-
---
127
source:
138
file: steps-install-shell-base.yaml
149
ref: download-archive

‎source/includes/steps-install-shell-windows.yaml

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,6 @@ source:
44
ref: navigate-dlc
55
ref: navigate-dlc-windows
66
---
7-
source:
8-
file: steps-install-shell-base.yaml
9-
ref: open-mdb-shell-page
10-
ref: open-mdb-shell-page-windows
11-
---
127
source:
138
file: steps-install-shell-base.yaml
149
ref: download-archive
@@ -18,7 +13,7 @@ title: "Extract the files from the downloaded archive."
1813
ref: extract-archive
1914
level: 4
2015
---
21-
title: "Add the MongoDB Shell binary to your ``PATH`` environment
16+
title: "Add the ``mongosh`` binary to your ``PATH`` environment
2217
variable."
2318
ref: add-shell-to-path
2419
level: 4
@@ -31,7 +26,7 @@ content: |
3126
To add the |mdb-shell| binary's location to your
3227
``PATH`` environment variable:
3328
34-
1. Open the :guilabel:`Control Panel`.
29+
a. Open the :guilabel:`Control Panel`.
3530
3631
#. In the :guilabel:`System and Security` category, click
3732
:guilabel:`System`.

‎source/install.txt

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,35 @@ Procedure
7171

7272
.. tab::
7373
:tabid: linux
74+
75+
Select the appropriate tab based on your Linux distribution and
76+
desired package from the tabs below:
77+
78+
- To install the ``.deb`` package on Ubuntu and Debian,
79+
click the ``.deb`` tab.
80+
81+
- To install the ``.rpm`` package on
82+
:abbr:`RHEL (Red Hat Enterprise Linux)`, click the
83+
``.rpm`` tab.
84+
85+
- To install the ``.tgz`` tarball, click the ``.tgz`` tab.
86+
87+
.. tabs::
88+
89+
.. tab:: .deb
90+
:tabid: deb
91+
92+
.. include:: /includes/steps/install-shell-linux-deb.rst
93+
94+
.. tab:: .rpm
95+
:tabid: rpm
96+
97+
.. include:: /includes/steps/install-shell-linux-rpm.rst
98+
99+
.. tab:: .tgz
100+
:tabid: tgz
74101

75-
.. include:: /includes/steps/install-shell-generic-linux.rst
102+
.. include:: /includes/steps/install-shell-linux-generic.rst
76103

77104
Next Steps
78105
----------

0 commit comments

Comments
 (0)