Skip to content

DOCS-820 CSS changes, bottom next/prev navbar, link cleanup #440

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 7 commits into from
Nov 30, 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: 4 additions & 4 deletions source/administration/security.txt
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,8 @@ Network Interface Limitation

You can limit the network exposure with the following configuration options:

- the :setting:`nohttpinterface` setting for :program:`mongod` and
:program:`mongos` instances.
- the :setting:`nohttpinterface <mongod --nohttpinterface>` setting for
:program:`mongod` and :program:`mongos` instances.

Disables the "home" status page, which would run on port ``28017``
by default. The status interface is read-only by default. You may
Expand Down Expand Up @@ -170,7 +170,7 @@ You can limit the network exposure with the following configuration options:
:option:`mongos --bind_ip` option on the command line at run time to
limit the network accessibility of a MongoDB program.

.. important::
.. important::

Make sure that your :program:`mongod` and
:program:`mongos` instances are only accessible on trusted
Expand Down Expand Up @@ -340,7 +340,7 @@ Be aware of the following capabilities and behaviors of the

- :program:`mongo` will evaluate a ``.mongorc.js`` file before
starting. You can disable this behavior by passing the
:option:`mongo --norc`` option.
:option:`mongo --norc` option.

On Linux and Unix systems, :program:`mongo` reads the
:file:`.mongorc.js` file from :file:`{$HOME}/.mongorc.js`
Expand Down
2 changes: 1 addition & 1 deletion source/applications/delete.txt
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ following syntax:

.. code-block:: javascript

db.collection.delete( <query>, <justOne> )
db.collection.remove( <query>, <justOne> )

.. admonition:: Corresponding operation in SQL

Expand Down
2 changes: 1 addition & 1 deletion source/applications/replication.txt
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ on a majority of the set members before returning:
cfg.settings.getLastErrorDefaults = {w: "majority"}
rs.reconfig(cfg)

The :data:`getLastErrorDefaults` setting affects only those
The :data:`settings.getLastErrorDefaults` setting affects only those
:dbcommand:`getLastError` commands that have *no* other arguments.

.. note::
Expand Down
4 changes: 2 additions & 2 deletions source/core/read-operations.txt
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@ index can: support and optimize specific queries, sort operations, and
allow for more efficient storage utilization. For more information
about indexes in MongoDB see: :doc:`/indexes` and :doc:`/core/indexes`.

You can create indexes using the :method:`db.collection.ensureIndex{)` method
You can create indexes using the :method:`db.collection.ensureIndex()` method
in the :program:`mongo` shell, as in the following prototype
operation:

Expand Down Expand Up @@ -566,7 +566,7 @@ operations for more basic data aggregation operations:

- :method:`group()`

- :dbcommand:`mapReduce() <mapreduce>` (See also :wiki:`MapReduce`.)
- :dbcommand:`mapReduce() <mapReduce>` (See also :wiki:`MapReduce`.)

.. index:: read operation; architecture
.. _read-operations-architecture:
Expand Down
1 change: 0 additions & 1 deletion source/core/write-operations.txt
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ For information on specific methods used to perform write operations in the
- :method:`db.collection.save()`
- :method:`db.collection.findAndModify()`
- :method:`db.collection.remove()`
- :method:`db.collection.delete()`

For information on how to perform write operations from within an
application, see the :doc:`/applications/drivers` documentation or the
Expand Down
7 changes: 4 additions & 3 deletions source/includes/warning-sharding-hostnames.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@

If you use either "localhost" or ``127.0.0.1`` as the hostname
portion of any host identifier, for example as the ``host`` argument
to :dbcommand:`addShard` or the value to the :option:`mongos
--configdb` run time option, then you must use "localhost" or
to :dbcommand:`addShard` or the value to the
:option:`--configdb <mongos --configdb>`
run time option, then you must use "localhost" or
``127.0.0.1`` for *all* host settings for any MongoDB instances in
the cluster. If you mix localhost addresses and remote host address,
MongoDB will error.
MongoDB will error.
3 changes: 2 additions & 1 deletion source/reference/command/applyOps.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ applyOps (internal)
:param array operations: an array of operations to perform.

:param array preCondition: Optional. Defines one or more conditions that the destination must meet
applying the entries from the ``<operations>`` array. ``ns`` to
applying the entries from the ``<operations>`` array.
Use ``ns`` to
specify a :term:`namespace`, ``q`` to specify a :term:`query` and
``res`` to specify the result that the query should match. You may
specify zero, one, or many ``preCondition`` documents.
Expand Down
2 changes: 1 addition & 1 deletion source/reference/configuration-options.txt
Original file line number Diff line number Diff line change
Expand Up @@ -854,7 +854,7 @@ Sharding Cluster Options
random from this list.

The ping time used for a set member compared by the
:option:`--localThreshold` setting is a moving average of recent
:option:`--localThreshold <mongos --localThreshold>` setting is a moving average of recent
ping times, calculated, at most, every 10 seconds. As a result, some queries
may reach members above the threshold until the :program:`mongos`
recalculates the average.
Expand Down
8 changes: 4 additions & 4 deletions source/reference/limits.txt
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,9 @@ Indexes
index name is the concatenation of the field names and index
directions.

You can explicitly specify a name to :dbcommand:`createIndex` or
the :method:`db.collection.ensureIndex()` helper if the default
index name is too long.
You can explicitly specific a name to the
:method:`~db.collection.ensureIndex()`
helper if the default index name is too long.

.. _limit-sharding-unique-indexes:
.. limit:: Unique Indexes in Sharded Collections
Expand Down Expand Up @@ -122,7 +122,7 @@ Operations
.. limit:: Operations Unavailable in Sharded Environments

The :dbcommand:`group` does not work with sharding. Use
:dbcommand:`mapreduce` or :dbcommand:`aggregate` instead.
:dbcommand:`mapReduce` or :dbcommand:`aggregate` instead.

:method:`db.eval()` is incompatible with sharded collections. You may
use :method:`db.eval()` with un-sharded collections in a shard
Expand Down
30 changes: 30 additions & 0 deletions source/reference/method/db.collection.createIndex.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
===========================
db.collection.createIndex()
===========================

.. default-domain:: mongodb

.. method:: db.collection.createIndex(keys, options)

.. deprecated:: 1.8

:param document keys: A :term:`document` that contains
pairs with the name of the field or
fields to index and order of the index. A
``1`` specifies ascending and a ``-1``
specifies descending.

:param document options: A :term:`document` that controls the creation
of the index. This argument is optional.

The :method:`~db.collection.ensureIndex()` method is the preferred
way to create indexes on collections.

.. seealso:: :doc:`/indexes`,
:method:`~db.collection.createIndex()`,
:method:`~db.collection.dropIndex()`,
:method:`~db.collection.dropIndexes()`,
:method:`~db.collection.getIndexes()`,
:method:`~db.collection.reIndex()`,
:method:`~db.collection.totalIndexSize()`

19 changes: 19 additions & 0 deletions source/reference/method/db.collection.isCapped.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
==========================
db.collection.isCapped()
==========================

.. default-domain:: mongodb

.. method:: db.collection.isCapped()

Returns ``true`` if the collection is a :term:`capped collection`,
otherwise returns ``false``.

.. code-block:: javascript

> db.collection.isCapped()
true

Change ``collection`` to the name of the collection you want to check.

.. seealso:: :doc:`/core/capped-collections`
2 changes: 1 addition & 1 deletion source/reference/mongod.txt
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Options
the amount of output. This option suppresses:

- output from :term:`database commands <database command>`,
including :dbcommand:`drop`, :dbcommand:`dropIndex`,
including :dbcommand:`drop`, :dbcommand:`dropIndexes`,
:dbcommand:`diagLogging`, :dbcommand:`validate`, and
:dbcommand:`clean`.

Expand Down
27 changes: 27 additions & 0 deletions source/reference/operator/natural.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
========
$natural
========

.. default-domain:: mongodb

.. operator:: $natural

Use the :operator:`$natural` operator to use :term:`natural order` for
the results of a sort operation. Natural order refers to the
order of documents in the file on disk.

The :operator:`$natural` operator uses the following syntax to return
documents in the order they exist on disk:

.. code-block:: javascript

db.collection.sort( {$natural: 1} )

Use ``-1`` to return documents in the reverse order as they occur on
disk:

.. code-block:: javascript

db.collection.sort( {$natural: -1} )

.. seealso:: :method:`~cursor.sort()`
2 changes: 1 addition & 1 deletion source/release-notes/2.0.txt
Original file line number Diff line number Diff line change
Expand Up @@ -383,7 +383,7 @@ user's home directory. The shell will execute this file after connecting
to the database and before displaying the prompt.

If you would like the shell not to run the ``.mongorc.js`` file
automatically, start the shell with :option:`--norc <mongod --norc>`.
automatically, start the shell with :option:`--norc <mongo --norc>`.

For more information, see :doc:`/reference/mongo`.

Expand Down
6 changes: 4 additions & 2 deletions source/tutorial/change-oplog-size.txt
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,10 @@ procedure for every member of the set that may become primary.
mongod --dbpath /srv/mongodb --shutdown

To restart the instance on a different port and in "standalone" mode
(i.e. without :setting:`replSet` or :option:`--replSet <mongod
--replSet>`), use a command that resembles the following:
(i.e. without
:setting:`replSet <mongod replSet>` or
:option:`--replSet <mongod --replSet>`),
use a command that resembles the following:

.. code-block:: sh

Expand Down
2 changes: 1 addition & 1 deletion source/tutorial/install-mongodb-on-windows.txt
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ Run all of the following commands in :guilabel:`Command Prompt` with
operation. You may also specify :option:`--dbpath <mongod --dbpath>`
on the command line; however, always prefer the configuration file.

If the :setting:`dbpath`` directory does not exist,
If the :setting:`dbpath` directory does not exist,
:program:`mongod.exe` will not be able to start. The default value
for :setting:`dbpath` is ``\data\db``.

Expand Down
20 changes: 17 additions & 3 deletions themes/mongodb/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,21 @@
<link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
{%- endfor %}
{%- endmacro -%}
{%- macro render_nextprev() %}
<div id="btnv">
<ul id="btnvl">
{%- if prev %}
<li id="btnvpr"><a href="{{ prev.link|e }}" title="Previous Section: {{ prev.title|striptags|e }}">&larr; {{ prev.title|striptags|e }}</a></li>
{%- endif %}
{%- if parents %}
<li id="btnvup"><a href="{{ parents[0].link|e }}" title="Parent Section: {{ parents[0].title|striptags|e }}" >&uarr; {{ parents[0].title|striptags|e }}</a></li>
{%- endif %}
{%- if next %}
<li id="btnvnx"><a href="{{ next.link|e }}" title="Next Section: {{ next.title|striptags|e }}">{{ next.title|striptags|e }} &rarr;</a></li>
{%- endif %}
</ul>
</div>
{% endmacro -%}
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
{%- block htmltitle %}
Expand Down Expand Up @@ -176,9 +191,7 @@
</div>
<div id="header-db" class="spread">
<div class="split">
<div id="logo">
<div><a href="http://docs.mongodb.org/"><img src="{{ pathto('_static', 1) }}/logo-mongodb.png" width="190" height="55" alt="mongoDB" /></a></div>
</div>
<div id="logo"><a href="http://docs.mongodb.org/"><img src="http://media.mongodb.org/logo-mongodb.png" width="217" height="90" alt="mongoDB manual"></a></div>
</div>
<div class="search-db"><gcse:searchbox></gcse:searchbox></div>
<div id="etp">
Expand All @@ -201,6 +214,7 @@
<div class="body">
<div id="cse-results"><gcse:searchresults></gcse:searchresults></div>
{% block body %} {% endblock %}
{{- render_nextprev() -}}
</div>
{%- if render_sidebar %}
</div>
Expand Down
Loading