diff --git a/source/administration.txt b/source/administration.txt index 2d66fd1670a..26e89b258a0 100644 --- a/source/administration.txt +++ b/source/administration.txt @@ -2,57 +2,39 @@ Administration ============== -Core Competencies ------------------ +This page lists the core administrative documentation and the +administration tutorials. This page also provides links to +administrative documentation for replica sets, sharding, and indexes. + +Core Documentation +------------------ + +The following is 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 ` + - :doc:`/administration/indexes` - For information regarding administrative concerns related to - :doc:`indexes `, see ":doc:`/administration/indexes`." - +.. index:: tutorials; administration .. _administration-tutorials: Tutorials --------- -.. toctree:: - :hidden: - - tutorial/recover-data-following-unexpected-shutdown - tutorial/convert-replica-set-to-replicated-shard-cluster - -- :doc:`/tutorial/expire-data` -- :doc:`/tutorial/deploy-replica-set` -- :doc:`/tutorial/expand-replica-set` -- :doc:`/tutorial/deploy-geographically-distributed-replica-set` -- :doc:`/tutorial/change-hostnames-in-a-replica-set` -- :doc:`/tutorial/change-oplog-size` -- :doc:`/tutorial/install-mongodb-on-linux` -- :doc:`/tutorial/install-mongodb-on-redhat-centos-or-fedora-linux` -- :doc:`/tutorial/install-mongodb-on-os-x` -- :doc:`/tutorial/install-mongodb-on-debian-or-ubuntu-linux` -- :doc:`/tutorial/recover-data-following-unexpected-shutdown` -- :doc:`/tutorial/deploy-shard-cluster` -- :doc:`/tutorial/convert-replica-set-to-replicated-shard-cluster` -- :doc:`/tutorial/add-shards-to-shard-cluster` -- :doc:`/tutorial/remove-shards-from-cluster` +The following tutorials describe core administrative procedures: +.. include:: /includes/tutorial-list-administration.rst diff --git a/source/includes/tutorial-list-administration.rst b/source/includes/tutorial-list-administration.rst new file mode 100644 index 00000000000..761b2710f45 --- /dev/null +++ b/source/includes/tutorial-list-administration.rst @@ -0,0 +1,24 @@ +.. toctree:: + :maxdepth: 1 + + tutorial/install-mongodb-on-linux + tutorial/install-mongodb-on-redhat-centos-or-fedora-linux + tutorial/install-mongodb-on-os-x + tutorial/install-mongodb-on-debian-or-ubuntu-linux + tutorial/change-oplog-size + tutorial/deploy-replica-set + tutorial/deploy-geographically-distributed-replica-set + tutorial/expand-replica-set + tutorial/change-hostnames-in-a-replica-set + tutorial/recover-data-following-unexpected-shutdown + tutorial/deploy-shard-cluster + tutorial/convert-replica-set-to-replicated-shard-cluster + tutorial/add-shards-to-shard-cluster + tutorial/remove-shards-from-cluster + tutorial/expire-data + +.. toctree:: + :hidden: + + tutorial/recover-data-following-unexpected-shutdown + tutorial/convert-replica-set-to-replicated-shard-cluster diff --git a/source/indexes.txt b/source/indexes.txt index 46aca5579bd..727dceb416f 100644 --- a/source/indexes.txt +++ b/source/indexes.txt @@ -4,15 +4,19 @@ 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. + +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 outline of the main documentation: .. toctree:: :maxdepth: 2 diff --git a/source/reference/commands.txt b/source/reference/commands.txt index 4fea3fd361d..efcd7af7279 100644 --- a/source/reference/commands.txt +++ b/source/reference/commands.txt @@ -79,6 +79,8 @@ shell helpers. User Commands ------------- +.. _sharding-commands: + Sharding ~~~~~~~~ diff --git a/source/replication.txt b/source/replication.txt index 402b4893a9c..d880738bda6 100644 --- a/source/replication.txt +++ b/source/replication.txt @@ -5,19 +5,20 @@ 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 -`. +For procedures for performing certain replication tasks, see the :ref:`Tutorials +` list. Documentation ------------- -The following is the expanded outline of the main documentation: +The following is the outline of the main documentation: .. toctree:: :maxdepth: 2 @@ -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 diff --git a/source/sharding.txt b/source/sharding.txt index b1e1a8b2fea..f355b9240c6 100644 --- a/source/sharding.txt +++ b/source/sharding.txt @@ -2,43 +2,37 @@ Sharding ======== -.. index:: background; sharding .. _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 ` -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 ` -section to aid in diagnosing common issues with sharding. Use the -:ref:`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 procedures for performing certain sharding tasks, see the :ref:`Tutorials ` +list. Documentation ------------- +The following is the 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: @@ -46,8 +40,7 @@ Documentation Tutorials --------- -The following tutorials outline basic administrative process for -deploying and managing shard clusters: +The following tutorials describe specific sharding procedures: .. toctree:: :maxdepth: 1 @@ -55,10 +48,16 @@ deploying and managing shard clusters: tutorial/deploy-shard-cluster tutorial/add-shards-to-shard-cluster tutorial/remove-shards-from-cluster + tutorial/enforce-unique-keys-for-sharded-collections + +.. _sharding-reference: + +Reference +--------- + +The following reference section describes sharding commands: -Additionally, the :doc:`/tutorial/enforce-unique-keys-for-sharded-collections` -tutorial describes a sharding-specific application development -pattern. +- :ref:`sharding-commands` .. STUB tutorial/replace-one-configuration-server-in-a-shard-cluster .. STUB tutorial/replace-all-configuration-servers-in-a-shard-cluster diff --git a/source/tutorial.txt b/source/tutorial.txt index 3589cce63bc..efa4765f036 100644 --- a/source/tutorial.txt +++ b/source/tutorial.txt @@ -23,19 +23,7 @@ included here, please open a :issue:`Jira Case `. Administration -------------- -.. toctree:: - :maxdepth: 1 - - tutorial/change-oplog-size - tutorial/deploy-geographically-distributed-replica-set - tutorial/deploy-replica-set - tutorial/expand-replica-set - tutorial/change-hostnames-in-a-replica-set - tutorial/recover-data-following-unexpected-shutdown - tutorial/deploy-shard-cluster - tutorial/convert-replica-set-to-replicated-shard-cluster - tutorial/add-shards-to-shard-cluster - tutorial/remove-shards-from-cluster +.. include:: /includes/tutorial-list-administration.rst .. index:: tutorials; installation .. index:: installation tutorials