Skip to content

DOCS-487 updated Sharding, Administration, and Indexing sign posts #206

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.

Sign up for GitHub

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 4 commits into from
Sep 10, 2012
Merged

DOCS-487 updated Sharding, Administration, and Indexing sign posts #206

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7b8c32b
DOCS-487 updated Sharding sign-post
Sep 10, 2012
64b6587
DOCS-487 updated Administration sign-post
Sep 10, 2012
41f736b
DOCS-487 updated Indexes sign-post
Sep 10, 2012
ab31320
DOCS-487 edits to Sharding, Admin, Indexes
Sep 10, 2012
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
39 changes: 23 additions & 16 deletions source/administration.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,44 +2,52 @@
Administration
==============

Core Competencies
-----------------
This page lists the core administrative documentation, including
administration tutorials. This page also provides links to
administrative documentation for replica sets, sharding, and indexes.

Core Documentation
------------------

The following is the expanded outline of the core administration
documentation:

.. toctree::
:maxdepth: 1
:maxdepth: 2

administration/backups
administration/import-export
administration/monitoring
administration/configuration
administration/ssl
administration/monitoring
administration/import-export
administration/backups

.. seealso:: For more information regarding :term:`replica set`
administration, consider:
.. seealso::

- :doc:`/administration/replica-sets`
- :doc:`/administration/replication-architectures`

For more information regarding :term:`shard cluster`
administration: consider:

- :doc:`/administration/sharding`
- :doc:`/administration/sharding-architectures`
- :doc:`indexes </core/indexes>`
- :doc:`/administration/indexes`

For information regarding administrative concerns related to
:doc:`indexes </core/indexes>`, see ":doc:`/administration/indexes`."

.. index:: tutorials; administration
.. _administration-tutorials:

Tutorials
---------

The following tutorials describe core administrative procedures:

.. toctree::
:hidden:

tutorial/recover-data-following-unexpected-shutdown
tutorial/convert-replica-set-to-replicated-shard-cluster

.. TODO: Is there a way to replace this list below with the list in
.. /source/tutorial#tutorials-administration
.. That way, we'd have just one list to keep updated. -bg
Copy link
Contributor

Choose a reason for hiding this comment

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

we could have includes for both.


- :doc:`/tutorial/expire-data`
- :doc:`/tutorial/deploy-replica-set`
- :doc:`/tutorial/expand-replica-set`
Expand All @@ -55,4 +63,3 @@ Tutorials
- :doc:`/tutorial/convert-replica-set-to-replicated-shard-cluster`
- :doc:`/tutorial/add-shards-to-shard-cluster`
- :doc:`/tutorial/remove-shards-from-cluster`

24 changes: 15 additions & 9 deletions source/indexes.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,21 @@
Indexes
=======

MongoDB's indexes make it possible to provide high performance read
operations for frequently used queries. Indexes are particularly
useful where the total size of the documents exceeds the amount of
available RAM. This section has three main documents:
:doc:`/core/indexes` that explains basic indexing concepts and
options. :doc:`/administration/indexes` that outlines procedures and
operational concerns relevant to indexing. And
:doc:`/applications/indexes` that introduces how applications may
use indexes.
Indexes provide high performance read operations for frequently used
queries. Indexes are particularly useful where the total size of the
documents exceeds the amount of available RAM.

This page lists the main documents that describe indexes.
Copy link
Contributor

Choose a reason for hiding this comment

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

redundant to below?


For basic concepts and options, see :doc:`/core/indexes`. For procedures
and operational concerns, see :doc:`/administration/indexes`. For
information on how applications might use indexes, see
:doc:`/applications/indexes`.

Documentation
-------------

The following is the expanded outline of the main documentation:
Copy link
Contributor

Choose a reason for hiding this comment

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

remove expanded.


.. toctree::
:maxdepth: 2
Expand Down
2 changes: 2 additions & 0 deletions source/reference/commands.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ shell helpers.
User Commands
-------------

.. _sharding-commands:

Sharding
~~~~~~~~

Expand Down
10 changes: 6 additions & 4 deletions source/replication.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,15 @@ Replication
Database replication ensures redundancy, backup, and automatic failover.
Replication occurs through groups of servers known as replica sets.

This page lists the documents, tutorials, and reference pages that describe replica sets.
This page lists the documents, tutorials, and reference pages that
describe replica sets.

For an overview, see :doc:`/core/replication`. To work with members, see
:doc:`administration/replica-sets`. To configure deployment
architecture, see :doc:`administration/replication-architectures`. To
modify read and write operations, see :doc:`applications/replication`.
For common procedures, see the :ref:`tutorials list
<replica-set-tutorials-list>`.
For common procedures, see the :ref:`Tutorials
<replica-set-tutorials-list>` list.
Copy link
Contributor

Choose a reason for hiding this comment

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

link smell


Documentation
-------------
Expand All @@ -28,13 +29,14 @@ The following is the expanded outline of the main documentation:
applications/replication
core/replication-internals

.. index:: tutorials; replica sets
.. _replica-set-tutorials-list:

Tutorials
---------

The following tutorials describe certain replica set maintenance
operations in detail.
operations in detail:

.. toctree::
:maxdepth: 1
Expand Down
68 changes: 39 additions & 29 deletions source/sharding.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,52 +2,49 @@
Sharding
========

.. index:: background; sharding
.. This was the only sign-post page with an index entry at the top, and
.. the entry seemed unlikely to be used. I've removed it. For top-level
.. pages, we have the left column. -bg
Copy link
Contributor

Choose a reason for hiding this comment

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

LGTM, you can remove the comment


.. _sharding-background:

MongoDB provides an automatic sharding feature that distributes a
single logical database system across a cluster of machines. MongoDB
Sharding distributes a
single logical database system across a cluster of machines. Sharding
uses range-based portioning to distribute :term:`documents <document>`
in a single collection between members of a shard cluster based on a
specific ":term:`shard key`.

For a high-level introduction to the underlying concepts and operation
of sharding, consider ":doc:`/core/sharding`." To understand how
sharding works and to use sharding in your deployment, to read
":doc:`/administration/sharding-architectures`" document provides an
overview of basic system architectures.

Administrators of shard clusters should also read the
":doc:`/administration/sharding`" document. This resource contains a
catalog of procedures for configuring and maintaining shard clusters,
in addition to a :ref:`troubleshooting <sharding-troubleshooting>`
section to aid in diagnosing common issues with sharding. Use the
:ref:`sharding tutorials <sharding-tutorials>` for instructions on
complete administrative operations.

Finally, for details on MongoDB's internal operation of sharding, the
":doc:`/core/sharding-internals`" document addresses these underlying
concepts.
based on a
specific :term:`shard key`.

This page lists the documents, tutorials, and reference pages that
describe sharding.

For an overview, see :doc:`/core/sharding`. To configure, maintain, and
troubleshoot shard clusters, see :doc:`/administration/sharding`. For
deployment architectures, see
:doc:`/administration/sharding-architectures`. For details on the
internal operations of sharding, see :doc:`/core/sharding-internals`.
For common procedures, see the :ref:`Tutorials <sharding-tutorials>`
Copy link
Contributor

Choose a reason for hiding this comment

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

link should smell better

Copy link

Choose a reason for hiding this comment

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

?? smell better?

list.

Documentation
-------------

The following is the expanded outline of the main documentation:

.. toctree::
:maxdepth: 3

core/sharding
core/sharding-internals
administration/sharding
administration/sharding-architectures
core/sharding-internals

.. index:: tutorials; sharding
.. _sharding-tutorials:

Tutorials
---------

The following tutorials outline basic administrative process for
deploying and managing shard clusters:
The following tutorials describe basic administrative procedures:

.. toctree::
:maxdepth: 1
Expand All @@ -56,9 +53,22 @@ deploying and managing shard clusters:
tutorial/add-shards-to-shard-cluster
tutorial/remove-shards-from-cluster

Additionally, the :doc:`/tutorial/enforce-unique-keys-for-sharded-collections`
tutorial describes a sharding-specific application development
pattern.
The following tutorial describes a sharding-specific application
development pattern:

.. toctree::
:maxdepth: 1

tutorial/enforce-unique-keys-for-sharded-collections
Copy link
Contributor

Choose a reason for hiding this comment

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

rervert, re: in person conversation.


.. _sharding-reference:

Reference
---------

The following reference section describes sharding commands:

- :ref:`sharding-commands`

.. STUB tutorial/replace-one-configuration-server-in-a-shard-cluster
.. STUB tutorial/replace-all-configuration-servers-in-a-shard-cluster