Skip to content

Commit 3fe35af

Browse files
(DOCSP-10360): generic linux install instructions (#6)
* (DOCSP-10360): generic linux install instructions * (DOCSP-10360): kick off auto build
1 parent 0ae82cb commit 3fe35af

File tree

4 files changed

+83
-41
lines changed

4 files changed

+83
-41
lines changed

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

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,46 @@ level: 4
1313
content: |
1414
1515
Click :guilabel:`Tools`, then select :guilabel:`MongoDB Shell`.
16+
---
17+
title: "Download the installation archive."
18+
ref: download-archive
19+
level: 4
20+
---
21+
title: "Extract the files from the downloaded archive."
22+
ref: extract-archive
23+
level: 4
24+
content: |
25+
26+
.. code-block::
27+
28+
tar -zxvf path/to/archive
29+
30+
Skip this step if your web browser automatically unzips the file as
31+
part of the download.
32+
---
33+
title: "Add the MongoDB Shell binary to your ``PATH`` environment
34+
variable."
35+
ref: add-shell-to-path
36+
level: 4
37+
content: |
38+
39+
You can either:
40+
41+
- Copy the |mdb-shell| binary into a directory listed in your ``PATH``
42+
variable, such as ``/usr/local/bin`` (Update
43+
``/path/to/mongosh`` with your installation directory as
44+
appropriate)
45+
46+
.. code-block:: sh
47+
48+
sudo cp /path/to/mongosh /usr/local/bin/
49+
50+
- Create a symbolic link to the |mdb-shell| binary from a directory listed in
51+
your ``PATH`` variable, such as ``/usr/local/bin`` (Update
52+
``/path/to/mongosh`` with your installation directory as
53+
appropriate):
54+
55+
.. code-block:: sh
56+
57+
sudo ln -s /path/to/mongosh /usr/local/bin/
58+
...
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
source:
3+
file: steps-install-shell-base.yaml
4+
ref: navigate-dlc
5+
ref: navigate-dlc-generic-linux
6+
---
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
16+
---
17+
source:
18+
file: steps-install-shell-base.yaml
19+
ref: extract-archive
20+
ref: extract-archive-generic-linux
21+
---
22+
source:
23+
file: steps-install-shell-base.yaml
24+
ref: add-shell-to-path
25+
ref: add-shell-to-path-generic-linux
26+
27+
...

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

Lines changed: 12 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -9,47 +9,19 @@ source:
99
ref: open-mdb-shell-page
1010
ref: open-mdb-shell-page-macos
1111
---
12-
title: "Download the installation archive."
13-
ref: download-archive
14-
level: 4
15-
content: |
12+
source:
13+
file: steps-install-shell-base.yaml
14+
ref: download-archive
15+
ref: download-archive-macos
1616
---
17-
title: "Extract the files from the downloaded archive."
18-
ref: extract-archive
19-
level: 4
20-
content: |
21-
22-
.. code-block::
23-
24-
tar -zxvf path/to/archive
25-
26-
Skip this step if your web browser automatically unzips the file as
27-
part of the download.
17+
source:
18+
file: steps-install-shell-base.yaml
19+
ref: extract-archive
20+
ref: extract-archive-macos
2821
---
29-
title: "Add the MongoDB Shell binary to your ``PATH`` environment
30-
variable."
31-
ref: add-shell-to-path
32-
level: 4
33-
content: |
34-
35-
You can either:
36-
37-
- Copy the |mdb-shell| binary into a directory listed in your ``PATH``
38-
variable, such as ``/usr/local/bin`` (Update
39-
``/path/to/mongosh`` with your installation directory as
40-
appropriate)
41-
42-
.. code-block:: sh
43-
44-
sudo cp /path/to/mongosh /usr/local/bin/
45-
46-
- Create a symbolic link to the |mdb-shell| binary from a directory listed in
47-
your ``PATH`` variable, such as ``/usr/local/bin`` (Update
48-
``/path/to/mongosh`` with your installation directory as
49-
appropriate):
50-
51-
.. code-block:: sh
52-
53-
sudo ln -s /path/to/mongosh /usr/local/bin/
22+
source:
23+
file: steps-install-shell-base.yaml
24+
ref: add-shell-to-path
25+
ref: add-shell-to-path-macos
5426

5527
...

source/index.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Procedure
5454
.. tab::
5555
:tabid: linux
5656

57-
Hello, I am Linux (rpm / deb) content.
57+
.. include:: /includes/steps/install-shell-generic-linux.rst
5858

5959
Connect to a MongoDB Deployment
6060
-------------------------------

0 commit comments

Comments
 (0)