Skip to content

Commit ef2f6ce

Browse files
ravindk89kay-kim
authored andcommitted
DOCS-11126: Improvements to Installation Tutorials
- All tutorials include 'Verify MongoDB started successfully' step - All tutorials ensure user attempts to connect successfully to the mongod
1 parent 42f2742 commit ef2f6ce

5 files changed

+122
-13
lines changed

source/includes/steps-configure-windows-service-for-mongodb.yaml

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,39 @@ inherit:
4646
file: steps-create-manually-windows-service-for-mongodb.yaml
4747
ref: start-mongodb-service
4848
---
49-
title: Stop or remove the MongoDB service as needed.
5049
stepnum: 6
50+
source:
51+
file: steps-run-mongodb-on-linux.yaml
52+
ref: verify
53+
pre: |
54+
Verify that MongoDB has started successfully by checking the
55+
log file at ``c:\data\log\mongod.log`` for the following line:
56+
post: |
57+
If you modified the :setting:`systemLog.path`
58+
configuration file option, open the log file at that location to
59+
examine the process output.
60+
61+
You may see non-critical warnings in the process
62+
output. As long as you see the log line shown above, you can safely
63+
ignore these warnings during your initial evaluation of MongoDB.
64+
---
65+
title: Connect to MongoDB.
66+
stepnum: 7
67+
ref: connect
68+
pre: |
69+
To connect to MongoDB through the :program:`mongo.exe <mongo>` shell,
70+
open another :guilabel:`Command Prompt`.
71+
action:
72+
copyable: true
73+
language: powershell
74+
code: |
75+
"C:\Program Files\MongoDB\Server\3.6\bin\mongo.exe"
76+
post: |
77+
If you want to develop applications using .NET, see the documentation
78+
of :ecosystem:`C# and MongoDB </drivers/csharp>` for more information.
79+
---
80+
title: Stop or remove the MongoDB service as needed.
81+
stepnum: 8
5182
ref: stop
5283
action:
5384
- pre: |

source/includes/steps-create-manually-windows-service-for-mongodb.yaml

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,39 @@ action:
6464
code: |
6565
net start MongoDB
6666
---
67-
title: Stop or remove the MongoDB service as needed.
6867
stepnum: 6
68+
source:
69+
file: steps-run-mongodb-on-linux.yaml
70+
ref: verify
71+
pre: |
72+
Verify that MongoDB has started successfully by checking the
73+
log file at ``c:\data\log\mongod.log`` for the following line:
74+
post: |
75+
If you modified the :setting:`systemLog.path`
76+
configuration file option, open the log file at that location to
77+
examine the process output.
78+
79+
You may see non-critical warnings in the process
80+
output. As long as you see the log line shown above, you can safely
81+
ignore these warnings during your initial evaluation of MongoDB.
82+
---
83+
title: Connect to MongoDB.
84+
stepnum: 7
85+
ref: connect
86+
pre: |
87+
To connect to MongoDB through the :program:`mongo.exe <mongo>` shell,
88+
open another :guilabel:`Command Prompt`.
89+
action:
90+
copyable: true
91+
language: powershell
92+
code: |
93+
"C:\Program Files\MongoDB\Server\3.6\bin\mongo.exe"
94+
post: |
95+
If you want to develop applications using .NET, see the documentation
96+
of :ecosystem:`C# and MongoDB </drivers/csharp>` for more information.
97+
---
98+
title: Stop or remove the MongoDB service as needed.
99+
stepnum: 8
69100
ref: stop-mongodb-service
70101
action:
71102
- pre: "To stop the MongoDB service, use the following command:"

source/includes/steps-run-mongodb-on-debian.yaml

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,19 @@ pre: |
1919
action:
2020
language: none
2121
code: |
22-
[initandlisten] waiting for connections on port <port>
22+
[initandlisten] waiting for connections on port 27017
2323
post: |
24-
where ``<port>`` is the port configured in ``/etc/mongod.conf``, ``27017`` by default.
24+
``<port>`` is the port the :program:`mongod` listens on. If you
25+
modified the :setting:`net.port` setting in the ``/etc/mongod.conf``
26+
configuration file, the port may differ.
27+
28+
If you modified the :setting:`systemLog.path` configuration
29+
file option, look for the log file at the location you specified
30+
to that setting.
31+
32+
You may see non-critical warnings in the :program:`mongod`
33+
output. As long as you see the log line shown above, you can safely
34+
ignore these warnings during your initial evaluation of MongoDB.
2535
---
2636
title: Stop MongoDB.
2737
stepnum: 3

source/includes/steps-run-mongodb-on-linux.yaml

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,43 @@ action:
5858
mongod --dbpath <path to data directory>
5959
# End-for-getting-started-guide
6060
---
61-
title: Begin using MongoDB.
61+
title: Verify that MongoDB has started successfully
6262
stepnum: 4
63+
ref: verify
64+
pre: |
65+
Verify that MongoDB has started successfully by
66+
checking the process output for the following line:
67+
action:
68+
language: none
69+
code: |
70+
[initandlisten] waiting for connections on port 27017
71+
post: |
72+
73+
The output should be visible in the terminal or shell window.
74+
75+
You may see non-critical warnings in the process
76+
output. As long as you see the log line shown above, you can safely
77+
ignore these warnings during your initial evaluation of MongoDB.
78+
---
79+
title: Begin using MongoDB.
80+
stepnum: 5
6381
ref: begin-using-mongodb
64-
content: |
82+
pre: |
83+
84+
Start a :program:`mongo` shell on the same host machine as the
85+
:program:`mongod`. Use the :option:`--host` command line option
86+
to specify the localhost address and port that the :program:`mongod`
87+
listens on:
88+
action:
89+
language: shell
90+
code: |
91+
92+
mongo --host 127.0.0.1:27017
93+
post: |
94+
95+
If you started the :program:`mongod` on a different port, specify
96+
that port instead of ``27017``.
97+
6598
To help you start using MongoDB, MongoDB provides :ref:`Getting
6699
Started Guides <getting-started>` in various driver editions. See
67100
:ref:`getting-started` for the available editions.
@@ -71,4 +104,7 @@ content: |
71104
post: |
72105
Later, to stop MongoDB, press ``Control+C`` in the terminal where the
73106
:program:`mongod` instance is running.
107+
replacement:
108+
mongod: ":program:`mongod`"
109+
mongo: ":program:`mongo`"
74110
...

source/includes/steps-run-mongodb-on-windows.yaml

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,14 @@ post: |
5454
work network`` and click ``Allow access``. For additional information on
5555
security and MongoDB, please see the :doc:`Security Documentation </security>`.
5656
---
57-
title: Connect to MongoDB.
57+
title: Verify that MongoDB has started successfully
5858
stepnum: 3
59+
source:
60+
file: steps-run-mongodb-on-linux.yaml
61+
ref: verify
62+
---
63+
title: Connect to MongoDB.
64+
stepnum: 4
5965
ref: connect
6066
pre: |
6167
To connect to MongoDB through the :program:`mongo.exe <mongo>` shell,
@@ -69,9 +75,4 @@ post: |
6975
If you want to develop applications using .NET, see the documentation
7076
of :ecosystem:`C# and MongoDB </drivers/csharp>` for more information.
7177
# End-for-getting-started-guide
72-
---
73-
stepnum: 4
74-
source:
75-
file: steps-run-mongodb-on-linux.yaml
76-
ref: begin-using-mongodb
77-
...
78+
...

0 commit comments

Comments
 (0)