DOCS-487 edits to Sharding, Admin, Indexes

Author: Bob Grabar

source/administration.txt

@@ -2,15 +2,14 @@
 Administration
 ==============
 
-This page lists the core administrative documentation, including
+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 expanded outline of the core administration
-documentation:
+The following is the core administration documentation:
 
 .. toctree::
    :maxdepth: 2
@@ -38,28 +37,4 @@ 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
-
-- :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`
+.. include:: /includes/tutorial-list-administration.rst

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

source/indexes.txt

@@ -8,8 +8,6 @@ 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.
-
 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
@@ -18,7 +16,7 @@ information on how applications might use indexes, see
 Documentation
 -------------
 
-The following is the expanded outline of the main documentation:
+The following is the outline of the main documentation:
 
 .. toctree::
    :maxdepth: 2

source/replication.txt

@@ -12,13 +12,13 @@ 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
+For procedures for performing certain replication tasks, see the :ref:`Tutorials
 <replica-set-tutorials-list>` list.
 
 Documentation
 -------------
 
-The following is the expanded outline of the main documentation:
+The following is the outline of the main documentation:
 
 .. toctree::
    :maxdepth: 2

source/sharding.txt

@@ -2,10 +2,6 @@
 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
-
 .. _sharding-background:
 
 Sharding distributes a
@@ -22,13 +18,13 @@ 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>`
+For procedures for performing certain sharding tasks, see the :ref:`Tutorials <sharding-tutorials>`
 list.
 
 Documentation
 -------------
 
-The following is the expanded outline of the main documentation:
+The following is the outline of the main documentation:
 
 .. toctree::
    :maxdepth: 3
@@ -44,21 +40,14 @@ The following is the expanded outline of the main documentation:
 Tutorials
 ---------
 
-The following tutorials describe basic administrative procedures:
+The following tutorials describe specific sharding procedures:
 
 .. toctree::
    :maxdepth: 1
 
    tutorial/deploy-shard-cluster
    tutorial/add-shards-to-shard-cluster
    tutorial/remove-shards-from-cluster
-
-The following tutorial describes a sharding-specific application
-development pattern:
-
-.. toctree::
-   :maxdepth: 1
-
    tutorial/enforce-unique-keys-for-sharded-collections
 
 .. _sharding-reference:

source/tutorial.txt

@@ -23,19 +23,7 @@ included here, please open a :issue:`Jira Case <DOCS>`.
 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