DOCS-135 editing installation and tutorials with siddharth's comments.

Author: Sam Kleinman

source/tutorial/deploy-geographically-distributed-replica-set.rst

@@ -55,13 +55,11 @@ following notes:
 
 Procedure
 ---------
-// TODO : Can you please rewrite this sentence. Its clear what you are trying to say
-but when read as a whole line, i feel as if it doesn't flow as a sentence.
 
-Although its possible to deploy multiple members on a single system,
-it reduces the redundancy and capacity of the system, these kinds of
-deployments are typically for testing purposes and beyond the scope of
-this tutorial.
+Although you may to deploy more than one replica set member on a
+single system, this configuration reduces the redundancy and capacity
+of the replica set. Such deployments are typically for testing
+purposes and beyond the scope of this tutorial.
 
 Three Member Replica Set
 ~~~~~~~~~~~~~~~~~~~~~~~~

source/tutorial/expand-replica-set.rst

@@ -37,8 +37,8 @@ tutorials which address these processes:
 Procedure
 ---------
 
-On the new system, ensure that a configuration file that resembles the
-following is located on the file system at ``/etc/mongodb.conf``.
+On the new system, create a configuration file that resembles the
+following on your system at ``/etc/mongodb.conf``.
 
 .. code-block:: cfg
 
@@ -48,13 +48,11 @@ following is located on the file system at ``/etc/mongodb.conf``.
 
    dbpath = /srv/mongodb/
 
-   fork = true
+   logpath = /var/log/mongodb.log
 
-   replSet = rs0/mongodb0.example.net,mongodb1.example.net,mongodb2.example.net,mongodb3.example.net
+   fork = true
 
-//TODO : On using fork=true, I received an error saying that "--fork has to be used with --logpath" 
-         Please verify
-  
+   replSet = rs0
 
 Modify the :setting:`bind_ip` to reflect a secure interface on
 your system that will be able to access all other members of the set
@@ -65,29 +63,26 @@ private network (i.e. "VPN") to permit this access.
 
 // TODO : Please also add a line about the port variable
 
+See the documentation of the configuration options used above:
+:setting:`dbpath`, :setting:`port`, :setting:`replSet`,
+:setting:`bind_ip`, and :setting:`fork`. Also consider any additional
+:doc:`configuration options </reference/configuration-options>` that
+your deployment may require.
 
 .. note::
 
-   The portion of the :setting:`replSet` following the ``/``
-   provides a "seed list" of hosts that are known to be members of the
-   same replica set, which is used for fetching changed configurations
-   following restarts. It is acceptable to omit this section entirely,
-   and have the :setting:`replSet` option resemble:
+   The default MongoDB port is ``27017``, and the remainder of the
+   tutorial assumes that all MongoDB instances are running on the
+   default port. If your MongoDB instances run on a different port,
+   you will need to change the :setting:`port` above, and append a
+   colon (``:``) and the port number to all host name references
+   below.
 
-   .. code-block:: cfg
+Start the :program:`mongod` process with the following command:
 
-      replSet = rs0
+.. code-block:: sh
 
-See the documentation of the configuration options used above:
-:setting:`dbpath`, :setting:`port`,
-:setting:`replSet`, :setting:`bind_ip`, and
-:setting:`fork`. Also consider any additional
-:doc:`configuration options </reference/configuration-options>` that
-your deployment may require.
-
-Start the :program:`mongod` process with the following command: ::
-
-     mongod --config /etc/mongodb.conf
+   mongod --config /etc/mongodb.conf
 
 .. note::
 
@@ -96,9 +91,11 @@ Start the :program:`mongod` process with the following command: ::
    command. Control scripts are beyond the scope of this document.
 
 Log into one of the existing members of the current replica set by
-issuing the following command: ::
+issuing the following command:
+
+.. code-block:: sh
 
-     mongo mongodb0.example.net
+   mongo mongodb0.example.net
 
 If this instance is not currently the :term:`primary` node, use the
 :func:`db.isMaster()` function to determine which node is in the

source/tutorial/install-mongodb-on-debian-or-ubuntu-linux.rst

@@ -63,7 +63,7 @@ The Debian/Ubuntu package management tool (i.e. ``dpkg`` and ``apt``)
 ensure package consistency and authenticity by requring that
 distributors sign packages with GPG keys. Issue the following command
 to import the `10gen public GPG Key </_static/10gen-gpg-key.asc>`_ as
-the root user:
+the root user (or with ``sudo``:)
 
 .. code-block:: sh
 
@@ -73,7 +73,7 @@ Alternatively, you may use ``sudo`` to get root privileges:
 
 .. code-block:: sh
 
-   sudo apt-key adv --keyserver keyserver.ubuntu.com --recv 7F0CEB10
+   apt-key adv --keyserver keyserver.ubuntu.com --recv 7F0CEB10
 
 Edit the ``/etc/apt/sources.list`` file to include the 10gen
 repository.
@@ -138,21 +138,18 @@ Controlling  MongoDB
 Starting MongoDB
 ~~~~~~~~~~~~~~~~
 
-// TODO : Please add that the following commands should be run with root (sudo) privileges. 
-       
-
-Upstart users can start the :program:`mongod` process by issuing the following
-command:
+Upstart users can start the :program:`mongod` process by issuing the
+following command:
 
 .. code-block:: sh
 
-   service mongodb start
+   sudo service mongodb start
 
 All other users can issue the following command to start :program:`mongod`:
 
 .. code-block:: sh
 
-   /etc/init.d/mongodb start
+   sudo /etc/init.d/mongodb start
 
 You can verify that :program:`mongod` has started successfully by checking the
 contents of the log file at ``/var/log/mongodb/mongodb.log``.
@@ -165,13 +162,13 @@ command:
 
 .. code-block:: sh
 
-   service mongodb stop
+   sudo service mongodb stop
 
 All other users can issue the following command to stop :program:`mongod`:
 
 .. code-block:: sh
 
-   /etc/init.d/mongodb stop
+   sudo /etc/init.d/mongodb stop
 
 Restarting MongoDB
 ~~~~~~~~~~~~~~~~~~
@@ -181,14 +178,14 @@ following command:
 
 .. code-block:: sh
 
-   service mongodb restart
+   sudo service mongodb restart
 
 All other users can issue the following command to restart
 :program:`mongod`:
 
 .. code-block:: sh
 
-   /etc/init.d/mongodb restart
+   sudo /etc/init.d/mongodb restart
 
 Controlling :program:`mongos`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

source/tutorial/install-mongodb-on-linux.rst

@@ -41,13 +41,20 @@ most cases you will want to download the 64-bit version of MongoDB.
 
 .. code-block:: sh
 
-   curl http://downloads.mongodb.org/linux/mongodb-linux-x86_64-latest.tgz > mongo.tgz
+   curl http://downloads.mongodb.org/linux/mongodb-linux-x86_64-x.y.z.tgz > mongo.tgz
 
 If you need to run the 32-bit version, use the following command.
 
 .. code-block:: sh
 
-   curl http://downloads.mongodb.org/linux/mongodb-linux-i686-latest.tgz > mongo.tgz
+   curl http://downloads.mongodb.org/linux/mongodb-linux-i686-x.y.z.tgz > mongo.tgz
+
+.. note::
+
+   Replace x.y.z with the current stable version (i.e. |version|).
+
+   You may also choose to install a development release, in which case
+   you will need to specify that version number above.
 
 Once you've downloaded the release, issue the following command to
 extract the files from the archive:
@@ -58,16 +65,12 @@ extract the files from the archive:
 
 .. optional::
 
-   You may use the following command to move the extracted folder into
+   You may use the following command to copy the extracted folder into
    a more generic location.
 
-   //TODO: this is an installation guide for linux hence the package that will be downloaded
-           will probably have name like mongodb-linux-x86_64?-20??-??-?? 
-           and not mongdo-osx-20??-??-?? that you have mentioned below.
-
    .. code-block:: sh
 
-      mv -n mongodb-osx-20??-??-??/ mongodb
+      cp -R -n  mongodb-osx-20??-??-??/ mongodb
 
 You can find the :program:`mongod` binary, and the binaries all of the
 associated MongoDB utilities, in the "``bin/``" directory within the
@@ -85,36 +88,59 @@ following command:
 
    mkdir -p /data/db
 
-// TODO: you might want to mention that the users should also give write permissions
-         to the directory /data/db or wherever they want the dbpath to point to.
+.. note::
+
+   Ensure that the system account that will run the :program:`mongod`
+   process has read and write permissions to this directory. If
+   :program:`mongod` runs under the ``mongo`` user account, issue the
+   following command to change the owner of this folder:
+
+   .. code-block:: sh
+
+      chown mongo /data/db
+
+   If you use an alternate location for your data directory, ensure
+   that this user can write to your chosen data path.
 
 You can specify, and create, an alternate path using the
 :option:`--dbpath <mongod>` option to :program:`mongod` and the above
 command.
 
-// TODO : the part to start mongod is completely missing. I think we should add a few lines
-          on how to  start the mongod process. The previous step tells how to create a directory,
-          the next step tells how to use the mongo shell. We should definitely have a line on how to start
-          the mongod process.
-
 The 10gen builds of MongoDB contain no :term:`control scripts <control
 script>` or method to control the :program:`mongod` process. You may
 wish to create control scripts, modify your path, and/or create
 symbolic links to the MongoDB programs in your ``/usr/local/bin`` or
 "``/usr/bin``" directory for easier use.
 
+For testing purposes, you can start a :program:`mongod` directly in
+the terminal without creating a control script:
+
+.. code-block:: sh
+
+   mongod --config /etc/mongod.conf
+
+.. note::
+
+   The above command assumes that the :program:`mongod` binary is
+   accessible via your system's search path, and that you have created
+   a default configuration file located at ``/etc/mongod.conf``.
+
 Among the tools included with this MongoDB distribution, is the
 :program:`mongo` shell. You can use this shell to connect to your
 MongoDB instance by issuing the following command at the system
 prompt:
-  
-   TODO : You might want to add that the following command is to be issued
-         from the directory in which mongodb was extracted to. './bin' is not very descritpive.
 
 .. code-block:: sh
 
    ./bin/mongo
 
+.. note::
+
+   The ``./bin/mongo`` command assumes that the :program:`mongo`
+   binary is in the "``bin/``" sub-directory of the current
+   directory. This is the directory into which you extracted the
+   "``.tgz``" file.
+
 This will connect to the database running on the localhost interface
 by default. At the :program:`mongo` prompt, issue the following two
 commands to insert a record in the "test" :term:`collection` of the

source/tutorial/install-mongodb-on-os-x.rst

@@ -173,6 +173,19 @@ wish to create control scripts, modify your path, and/or create
 symbolic links to the MongoDB programs in your ``/usr/local/bin``
 directory for easier use.
 
+For testing purposes, you can start a :program:`mongod` directly in
+the terminal without creating a control script:
+
+.. code-block:: sh
+
+   mongod --config /etc/mongod.conf
+
+.. note::
+
+   This command assumes that the :program:`mongod` binary is
+   accessible via your system's search path, and that you have created
+   a default configuration file located at ``/etc/mongod.conf``.
+
 Among the tools included with this MongoDB distribution, is the
 :program:`mongo` shell. You can use this shell to connect to your
 MongoDB instance by issuing the following command at the system
@@ -182,6 +195,14 @@ prompt:
 
    ./bin/mongo
 
+
+.. note::
+
+   The ``./bin/mongo`` command assumes that the :program:`mongo`
+   binary is in the "``bin/``" sub-directory of the current
+   directory. This is the directory into which you extracted the
+   "``.tgz``" file.
+
 This will connect to the database running on the localhost interface
 by default. At the :program:`mongo` prompt, issue the following two
 commands to insert a record in the "test" :term:`collection` of the