Skip to content

DOCS-11126: Improvements to Installation Tutorials #3169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 15, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 32 additions & 1 deletion source/includes/steps-configure-windows-service-for-mongodb.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,39 @@ inherit:
file: steps-create-manually-windows-service-for-mongodb.yaml
ref: start-mongodb-service
---
title: Stop or remove the MongoDB service as needed.
stepnum: 6
source:
file: steps-run-mongodb-on-linux.yaml
ref: verify
pre: |
Verify that MongoDB has started successfully by checking the
log file at ``c:\data\log\mongod.log`` for the following line:
post: |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what line?

Copy link
Contributor Author

@ravindk89 ravindk89 Dec 15, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this pulls in the action from the inherited file, so the line ends up being the initAndListen log file. Staged here: https://docs-mongodbcom-staging.corp.mongodb.com/rkumar/DOCS-11126/tutorial/install-mongodb-on-windows.html#id3

If you modified the :setting:`systemLog.path`
configuration file option, open the log file at that location to
examine the process output.

You may see non-critical warnings in the process
output. As long as you see the log line shown above, you can safely
ignore these warnings during your initial evaluation of MongoDB.
---
title: Connect to MongoDB.
stepnum: 7
ref: connect
pre: |
To connect to MongoDB through the :program:`mongo.exe <mongo>` shell,
open another :guilabel:`Command Prompt`.
action:
copyable: true
language: powershell
code: |
"C:\Program Files\MongoDB\Server\3.6\bin\mongo.exe"
post: |
If you want to develop applications using .NET, see the documentation
of :ecosystem:`C# and MongoDB </drivers/csharp>` for more information.
---
title: Stop or remove the MongoDB service as needed.
stepnum: 8
ref: stop
action:
- pre: |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,39 @@ action:
code: |
net start MongoDB
---
title: Stop or remove the MongoDB service as needed.
stepnum: 6
source:
file: steps-run-mongodb-on-linux.yaml
ref: verify
pre: |
Verify that MongoDB has started successfully by checking the
log file at ``c:\data\log\mongod.log`` for the following line:
post: |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

? what line?

If you modified the :setting:`systemLog.path`
configuration file option, open the log file at that location to
examine the process output.

You may see non-critical warnings in the process
output. As long as you see the log line shown above, you can safely
ignore these warnings during your initial evaluation of MongoDB.
---
title: Connect to MongoDB.
stepnum: 7
ref: connect
pre: |
To connect to MongoDB through the :program:`mongo.exe <mongo>` shell,
open another :guilabel:`Command Prompt`.
action:
copyable: true
language: powershell
code: |
"C:\Program Files\MongoDB\Server\3.6\bin\mongo.exe"
post: |
If you want to develop applications using .NET, see the documentation
of :ecosystem:`C# and MongoDB </drivers/csharp>` for more information.
---
title: Stop or remove the MongoDB service as needed.
stepnum: 8
ref: stop-mongodb-service
action:
- pre: "To stop the MongoDB service, use the following command:"
Expand Down
14 changes: 12 additions & 2 deletions source/includes/steps-run-mongodb-on-debian.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,19 @@ pre: |
action:
language: none
code: |
[initandlisten] waiting for connections on port <port>
[initandlisten] waiting for connections on port 27017
post: |
where ``<port>`` is the port configured in ``/etc/mongod.conf``, ``27017`` by default.
``<port>`` is the port the :program:`mongod` listens on. If you
modified the :setting:`net.port` setting in the ``/etc/mongod.conf``
configuration file, the port may differ.

If you modified the :setting:`systemLog.path` configuration
file option, look for the log file at the location you specified
to that setting.

You may see non-critical warnings in the :program:`mongod`
output. As long as you see the log line shown above, you can safely
ignore these warnings during your initial evaluation of MongoDB.
---
title: Stop MongoDB.
stepnum: 3
Expand Down
40 changes: 38 additions & 2 deletions source/includes/steps-run-mongodb-on-linux.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,43 @@ action:
mongod --dbpath <path to data directory>
# End-for-getting-started-guide
---
title: Begin using MongoDB.
title: Verify that MongoDB has started successfully
stepnum: 4
ref: verify
pre: |
Verify that MongoDB has started successfully by
checking the process output for the following line:
action:
language: none
code: |
[initandlisten] waiting for connections on port 27017
post: |

The output should be visible in the terminal or shell window.

You may see non-critical warnings in the process
output. As long as you see the log line shown above, you can safely
ignore these warnings during your initial evaluation of MongoDB.
---
title: Begin using MongoDB.
stepnum: 5
ref: begin-using-mongodb
content: |
pre: |

Start a :program:`mongo` shell on the same host machine as the
:program:`mongod`. Use the :option:`--host` command line option
to specify the localhost address and port that the :program:`mongod`
listens on:
action:
language: shell
code: |

mongo --host 127.0.0.1:27017
post: |

If you started the :program:`mongod` on a different port, specify
that port instead of ``27017``.

To help you start using MongoDB, MongoDB provides :ref:`Getting
Started Guides <getting-started>` in various driver editions. See
:ref:`getting-started` for the available editions.
Expand All @@ -71,4 +104,7 @@ content: |
post: |
Later, to stop MongoDB, press ``Control+C`` in the terminal where the
:program:`mongod` instance is running.
replacement:
mongod: ":program:`mongod`"
mongo: ":program:`mongo`"
...
15 changes: 8 additions & 7 deletions source/includes/steps-run-mongodb-on-windows.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,14 @@ post: |
work network`` and click ``Allow access``. For additional information on
security and MongoDB, please see the :doc:`Security Documentation </security>`.
---
title: Connect to MongoDB.
title: Verify that MongoDB has started successfully
stepnum: 3
source:
file: steps-run-mongodb-on-linux.yaml
ref: verify
---
title: Connect to MongoDB.
stepnum: 4
ref: connect
pre: |
To connect to MongoDB through the :program:`mongo.exe <mongo>` shell,
Expand All @@ -69,9 +75,4 @@ post: |
If you want to develop applications using .NET, see the documentation
of :ecosystem:`C# and MongoDB </drivers/csharp>` for more information.
# End-for-getting-started-guide
---
stepnum: 4
source:
file: steps-run-mongodb-on-linux.yaml
ref: begin-using-mongodb
...
...