Skip to content

Documentation review #6

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 9 commits into from
Mar 5, 2012
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
8 changes: 8 additions & 0 deletions source/reference/mongos.rst
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,14 @@ Options
specify either 1 configuration server or 3 configuration servers,
in a comma separated list.

.. note::

Each :program:`mongos` reads from the first :term:`config server
<config database>` in the list provided. If your configuration
databases reside in more that one data center, you should
specify the closest config servers as the first servers in the
list.

.. option:: --test

This option is for internal testing use only, and runs unit tests
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +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,
reduces the redundancy and capacity of the system, these kinds of
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.

Expand Down Expand Up @@ -176,7 +178,7 @@ configuration </reference/replica-configuration>`:
rs.config()

Now, issue the following sequence of commands to add the remaining
members to the replica set. The following example assumes that the
members to the replica set. The following examrsple assumes that the
current primary is ``mongodb0.example.net``.

.. code-block:: javascript
Expand Down
7 changes: 7 additions & 0 deletions source/tutorial/expand-replica-set.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,20 @@ following is located on the file system at ``/etc/mongodb.conf``.

replSet = rs0/mongodb0.example.net,mongodb1.example.net,mongodb2.example.net,mongodb3.example.net

//TODO : On using fork=true, I received an error saying that "--fork has to be used with --logpath"
Please verify


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
*and* on which all other members of the replica set can access the
current node. The DNS or host names need to resolve to this IP address
on the other members of the set. Configure network rules or a virtual
private network (i.e. "VPN") to permit this access.

// TODO : Please also add a line about the port variable


.. note::

The portion of the :setting:`replSet` following the ``/``
Expand Down
3 changes: 3 additions & 0 deletions source/tutorial/install-mongodb-on-debian-or-ubuntu-linux.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,9 @@ 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:

Expand Down
21 changes: 18 additions & 3 deletions source/tutorial/install-mongodb-on-linux.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Synopsis
--------

10gen provides compiled versions of :term:`MongoDB` for use on Linux
that provides an simple option for users who cannot use packages. This
that provides a simple option for users who cannot use packages. This
tutorial outlines the basic installation of MongoDB using these
packages and an initial usage guide.
compiled versions and an initial usage guide.

.. seealso:: The documentation of following related processes and
concepts.
Expand Down Expand Up @@ -61,13 +61,17 @@ extract the files from the archive:
You may use the following command to move 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

You can find the :program:`mongod` binary, and the binaries all of the
associated MongoDB utilities, in the "``bin/``" directory within the
archive.
extracted directory.

Using MongoDB
~~~~~~~~~~~~~
Expand All @@ -81,10 +85,18 @@ 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.

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
Expand All @@ -95,6 +107,9 @@ 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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ configuration and operation.
Package Options
---------------

The 10gen repository contains for packages:
The 10gen repository contains four packages:

- ``mongo-10gen``

Expand Down Expand Up @@ -83,6 +83,8 @@ Installing MongoDB
Configure Package Management System (YUM)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

// TODO: please add instructions for yum update and that it needs to be executed after adding the repo.

Create a ``/etc/yum.repos.d/10gen.repo`` file to hold information
about your repository. If you are running a 64-bit system
(recommended,) place the following configuration in
Expand All @@ -94,6 +96,8 @@ about your repository. If you are running a 64-bit system
name=10gen Repository
baseurl=http://downloads-distro.mongodb.org/repo/redhat/os/x86_64
gpgcheck=0
// TODO : Dan Crosta suggested that this line be added
enabled=1

If you are running a 32-bit system, which isn't recommended for
production deployments, place the following configuration in
Expand All @@ -105,6 +109,8 @@ production deployments, place the following configuration in
name=10gen Repository
baseurl=http://downloads-distro.mongodb.org/repo/redhat/os/i686
gpgcheck=0
// TODO : Dan Crosta suggested that this line be added
enabled=1

Installing Packages
~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -145,6 +151,8 @@ Start MongoDB
Start the :program:`mongod` process by issuing the following command
(as root, or with ``sudo``):

// TODO : should be service mongod start and not 'mongodb' start

.. code-block:: sh

service mongodb start
Expand All @@ -166,6 +174,8 @@ Stop MongoDB
Stop the :program:`mongod` process by issuing the following command
(as root, or with ``sudo``):

// TODO : should be service mongod stop and not 'mongodb' stop

.. code-block:: sh

service mongodb stop
Expand All @@ -176,6 +186,8 @@ Restart MongoDB
You can restart the :program:`mongod` process by issuing the following
command (as root, or with ``sudo``):

// TODO : should be service mongod restart and not 'mongodb' restart

.. code-block:: sh

service mongodb restart
Expand Down