Skip to content

Commit 64b6587

Browse files
author
Bob Grabar
committed
DOCS-487 updated Administration sign-post
1 parent 7b8c32b commit 64b6587

File tree

3 files changed

+30
-24
lines changed

3 files changed

+30
-24
lines changed

source/administration.txt

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,44 +2,52 @@
22
Administration
33
==============
44

5-
Core Competencies
6-
-----------------
5+
This page lists the core administrative documentation, including
6+
administration tutorials. This page also provides links to
7+
administrative documentation for replica sets, sharding, and indexes.
8+
9+
Core Documentation
10+
------------------
11+
12+
The following is the expanded outline of the core administration
13+
documentation:
714

815
.. toctree::
9-
:maxdepth: 1
16+
:maxdepth: 2
1017

11-
administration/backups
12-
administration/import-export
13-
administration/monitoring
1418
administration/configuration
1519
administration/ssl
20+
administration/monitoring
21+
administration/import-export
22+
administration/backups
1623

17-
.. seealso:: For more information regarding :term:`replica set`
18-
administration, consider:
24+
.. seealso::
1925

2026
- :doc:`/administration/replica-sets`
2127
- :doc:`/administration/replication-architectures`
22-
23-
For more information regarding :term:`shard cluster`
24-
administration: consider:
25-
2628
- :doc:`/administration/sharding`
2729
- :doc:`/administration/sharding-architectures`
30+
- :doc:`indexes </core/indexes>`
31+
- :doc:`/administration/indexes`
2832

29-
For information regarding administrative concerns related to
30-
:doc:`indexes </core/indexes>`, see ":doc:`/administration/indexes`."
31-
33+
.. index:: tutorials; administration
3234
.. _administration-tutorials:
3335

3436
Tutorials
3537
---------
3638

39+
The following tutorials describe core administrative procedures:
40+
3741
.. toctree::
3842
:hidden:
3943

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

47+
.. TODO: Is there a way to replace this list below with the list in
48+
.. /source/tutorial#tutorials-administration
49+
.. That way, we'd have just one list to keep updated. -bg
50+
4351
- :doc:`/tutorial/expire-data`
4452
- :doc:`/tutorial/deploy-replica-set`
4553
- :doc:`/tutorial/expand-replica-set`
@@ -55,4 +63,3 @@ Tutorials
5563
- :doc:`/tutorial/convert-replica-set-to-replicated-shard-cluster`
5664
- :doc:`/tutorial/add-shards-to-shard-cluster`
5765
- :doc:`/tutorial/remove-shards-from-cluster`
58-

source/replication.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ For an overview, see :doc:`/core/replication`. To work with members, see
1212
:doc:`administration/replica-sets`. To configure deployment
1313
architecture, see :doc:`administration/replication-architectures`. To
1414
modify read and write operations, see :doc:`applications/replication`.
15-
For common procedures, see the :ref:`tutorials list
16-
<replica-set-tutorials-list>`.
15+
For common procedures, see the :ref:`Tutorials
16+
<replica-set-tutorials-list>` list.
1717

1818
Documentation
1919
-------------

source/sharding.txt

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ describe sharding.
2020
For an overview, see :doc:`/core/sharding`. To configure, maintain, and
2121
troubleshoot shard clusters, see :doc:`/administration/sharding`. For
2222
deployment architectures, see
23-
:doc:`/administration/sharding-architectures` For details on the
23+
:doc:`/administration/sharding-architectures`. For details on the
2424
internal operations of sharding, see :doc:`/core/sharding-internals`.
25-
For common procedures, see the :ref:`tutorials list
26-
<sharding-tutorials>`.
25+
For common procedures, see the :ref:`Tutorials <sharding-tutorials>`
26+
list.
2727

2828
Documentation
2929
-------------
@@ -44,8 +44,7 @@ The following is the expanded outline of the main documentation:
4444
Tutorials
4545
---------
4646

47-
The following tutorials describe basic administrative procedures for
48-
deploying and managing shard clusters:
47+
The following tutorials describe basic administrative procedures:
4948

5049
.. toctree::
5150
:maxdepth: 1
@@ -67,7 +66,7 @@ development pattern:
6766
Reference
6867
---------
6968

70-
The following describes sharding commands:
69+
The following reference section describes sharding commands:
7170

7271
- :ref:`sharding-commands`
7372

0 commit comments

Comments
 (0)