DOCSP-26432 replaces Read-Only - Replica Sets doc directives (mongodb#2253)

Author: jmd-mongo

source/administration/production-notes.txt

@@ -608,7 +608,7 @@ Architecture
 Replica Sets
 ~~~~~~~~~~~~
 
-See the :doc:`Replica Set Architectures </core/replica-set-architectures>`
+See the :ref:`Replica Set Architectures <replica-set-architecture>`
 document for an overview of architectural considerations for replica
 set deployments.
 

source/applications/replication.txt

@@ -1,3 +1,5 @@
+.. _replica-set-read-write-semantics:
+
 ====================================
 Replica Set Read and Write Semantics
 ====================================

source/faq/replica-sets.txt

@@ -14,19 +14,19 @@ FAQ: Replication and Replica Sets
    :class: singlecol
 
 This document answers common questions about replication in MongoDB.
-See also the :doc:`/replication` section in the manual, which provides
-an :doc:`overview of replication </replication>`, including details on:
+See also the :ref:`replication` section in the manual, which provides
+an overview of replication including details on:
 
-- :doc:`/core/replica-set-members`
+- :ref:`replica-set-members`
 
-- :doc:`/core/replica-set-architectures`
+- :ref:`replica-set-architecture`
 
-- :doc:`/core/replica-set-elections`
+- :ref:`replica-set-elections`
 
 What kind of replication does MongoDB support?
 ----------------------------------------------
 
-MongoDB supports :doc:`replica sets </replication>`, which can have up
+MongoDB supports :ref:`Replica sets <replication>`, which can have up
 to :ref:`50 nodes <3.0-replica-sets-max-members>`.
 
 Does replication work over the Internet and WAN connections?
@@ -40,7 +40,7 @@ recovery in a West-coast data center.
 
 .. seealso::
 
-   :doc:`/tutorial/deploy-geographically-distributed-replica-set`
+   :ref:`server-replica-set-deploy-geo`
 
 Can MongoDB replicate over a "noisy" connection?
 ------------------------------------------------
@@ -55,7 +55,7 @@ possible for the members of the node to keep up with the replication.
 
 .. seealso::
 
-   :doc:`/core/replica-set-elections`
+   :ref:`replica-set-elections`
 
 Why use journaling if replication already provides data redundancy?
 -------------------------------------------------------------------
@@ -92,8 +92,8 @@ following data with the rest of the replica set:
 If your MongoDB deployment uses TLS/SSL, then all communications
 between arbiters and the other members of the replica set are secure.
 
-See the documentation for :doc:`/tutorial/configure-ssl` for more
-information. As with all MongoDB components, run arbiters on secure
+See the documentation for :ref:`configure-mongod-mongos-for-tls-ssl` for 
+more information. As with all MongoDB components, run arbiters on secure
 networks.
 
 .. see:: 
@@ -118,7 +118,7 @@ Yes, unsharded replica sets can be renamed. This procedure requires
 downtime.
 
 To learn how to rename your replica set, see
-:doc:`/tutorial/rename-unsharded-replica-set`.
+:ref:`rename-a-replica-set`.
 
 Before renaming a replica set, perform a full
-:doc:`backup of your MongoDB deployment </core/backups>`.
+:ref:`backup of your MongoDB deployment <backup-methods>`.

source/introduction.txt

@@ -1,3 +1,5 @@
+.. _intro-to-mongodb:
+
 =======================
 Introduction to MongoDB
 =======================

source/reference.txt

@@ -1,3 +1,5 @@
+.. _reference-landing:
+
 =========
 Reference
 =========

source/reference/glossary.txt

@@ -1,3 +1,5 @@
+.. _glossary:
+
 ========
 Glossary
 ========

source/reference/log-messages.txt

@@ -92,7 +92,7 @@ output sent to:
 Output from the :dbcommand:`getLog` command is also in JSON format.
 
 Each log entry is output as a self-contained JSON object which follows
-the :doc:`Relaxed Extended JSON v2.0 </reference/mongodb-extended-json>`
+the :ref:`Relaxed Extended JSON v2.0 <mongodb-extended-json-v2>`
 specification, and has the following layout and field order:
 
 .. code-block:: javascript
@@ -186,8 +186,7 @@ Escaping
 
 The **message** and **attributes** fields will escape control
 characters as necessary according to the
-:doc:`Relaxed Extended JSON v2.0 </reference/mongodb-extended-json>`
-specification:
+Relaxed Extended JSON v2.0 specification:
 
 .. include:: /includes/fact-json-escape-sequences.rst
 

source/reference/mongodb-defaults.txt

@@ -1,3 +1,5 @@
+.. _default-mongodb-read-write-concerns:
+
 ============================================
 Default MongoDB Read Concerns/Write Concerns
 ============================================

source/reference/operator.txt

@@ -1,3 +1,5 @@
+.. _operator-ref-landing:
+
 =========
 Operators
 =========

source/reference/replica-set-protocol-versions.txt

@@ -1,3 +1,5 @@
+.. _replica-set-protocol-version:
+
 ============================
 Replica Set Protocol Version
 ============================

source/reference/sql-comparison.txt

@@ -1,3 +1,5 @@
+.. _sql-to-mongodb-mapping:
+
 ============================
 SQL to MongoDB Mapping Chart
 ============================

source/reference/write-concern.txt

@@ -18,9 +18,9 @@ Write Concern
 
 Write concern describes the level of acknowledgment requested from
 MongoDB for write operations to a standalone :binary:`~bin.mongod` or
-to :doc:`replica sets </replication>` or to :doc:`sharded clusters
-</sharding>`. In sharded clusters, :binary:`~bin.mongos` instances will
-pass the write concern on to the shards.
+to :ref:`Replica sets <replication>` or to :ref:`sharded clusters
+<sharding-background>`. In sharded clusters, :binary:`~bin.mongos` 
+instances will pass the write concern on to the shards.
 
 .. note::
 
@@ -181,8 +181,8 @@ available:
 
 .. seealso::
 
-   - :doc:`/reference/mongodb-defaults`
-   - :doc:`/reference/replica-set-protocol-versions`
+   - :ref:`default-mongodb-read-write-concerns`
+   - :ref:`replica-set-protocol-version`
 
 .. _wc-j:
 

source/release-notes/1.6.txt

@@ -38,7 +38,7 @@ downtime when the need arises.
 Replica Sets
 ------------
 
-:doc:`Replica sets </replication>`, which provide automated failover
+:ref:`Replica Sets <replication>`, which provide automated failover
 among a cluster of ``n`` nodes, are also now available.
 
 Please note that replica pairs are now deprecated; we strongly recommend

source/release-notes/4.2-downgrade.txt

@@ -71,7 +71,7 @@ fCV 4.2 features that are :ref:`incompatible with 4.0
 
 - :doc:`/core/index-wildcard`.
 
-- :doc:`Read-only view </core/views>` definitions and :ref:`collection
+- :ref:`Read-only view <views-landing-page>` definitions and :ref:`collection
   validation <schema-validation-query-expression>` definition that
   include 4.2 operators.
 

source/tutorial/deploy-replica-set-for-testing.txt

@@ -238,7 +238,7 @@ Check the status of your replica set at any time with the
    <https://github.com/mongodb/mongo-snippets/blob/master/replication/simple-setup.py>`_
    as an example of a basic automatically-configured replica set.
 
-   Refer to :doc:`Replica Set Read and Write Semantics </applications/replication>`
+   Refer to :ref:`Replica Set Read and Write Semantics <replica-set-read-write-semantics>`
    for a detailed explanation of read and write semantics in MongoDB.
 
 .. [#oplog]

source/tutorial/getting-started.txt

@@ -71,8 +71,8 @@ examples in the shell above.
       Populate a Collection (Insert)
       ------------------------------
 
-      MongoDB stores documents in :doc:`collections
-      </core/databases-and-collections>`. Collections are analogous to
+      MongoDB stores documents in :ref:`collections
+      <databases-and-collections>`. Collections are analogous to
       tables in relational databases. If a collection does not exist,
       MongoDB creates the collection when you first store data for that
       collection.
@@ -342,25 +342,25 @@ For additional examples, including MongoDB driver specific examples
 
    * - Query document examples
 
-     - - :doc:`/tutorial/query-documents`
+     - - :ref:`read-operations-queries`
 
-       - :doc:`/tutorial/query-embedded-documents`
+       - :ref:`read-operations-subdocuments`
 
-       - :doc:`/tutorial/query-arrays`
+       - :ref:`read-operations-arrays`
 
-       - :doc:`/tutorial/query-array-of-documents`
+       - :ref:`array-match-embedded-documents`
 
-       - :doc:`/tutorial/project-fields-from-query-results`
+       - :ref:`projection`
 
-       - :doc:`/tutorial/query-for-null-fields`
+       - :ref:`faq-developers-query-for-nulls`
 
    * - Update document examples
 
-     - - :doc:`/tutorial/update-documents`
+     - - :ref:`write-op-update`
 
    * - Delete document examples
 
-     - - :doc:`/tutorial/remove-documents`
+     - - :ref:`write-op-delete`
 
 Additional Topics
 ~~~~~~~~~~~~~~~~~
@@ -374,34 +374,34 @@ Additional Topics
      - Administrators
      - Reference
 
-   * - :doc:`/introduction`
+   * - :ref:`intro-to-mongodb`
 
        :ref:`Installation Guides <tutorial-installation>`
 
-       :doc:`/core/databases-and-collections`
+       :ref:`databases-and-collections`
 
-       :doc:`/core/document`
+       :ref:`bson-document-format`
 
      - :ref:`CRUD Operations <crud>`
 
        :ref:`Aggregation <aggregation>`
 
-       :doc:`SQL to MongoDB </reference/sql-comparison>`
+       :ref:`SQL to MongoDB <sql-to-mongodb-mapping>`
 
-       :doc:`/indexes`
+       :ref:`indexes`
 
-     - :doc:`/administration/production-notes`
+     - :ref:`production-notes`
 
-       :doc:`Replica Sets </replication>`
+       :ref:`Replica Sets <replication>`
 
-       :doc:`Sharded Clusters </sharding>`
+       :ref:`Sharded Clusters <sharding-background>`
 
-       :doc:`MongoDB Security </security>`
+       :ref:`MongoDB Security <security>`
 
-     - :doc:`Shell Methods </reference/method>`
+     - :ref:`Shell Methods <js-administrative-methods>`
 
-       :doc:`Query Operators </reference/operator>`
+       :ref:`Query Operators <operator-ref-landing>`
 
-       :doc:`Reference </reference>`
+       :ref:`Reference <reference-landing>`
 
-       :doc:`/reference/glossary`
+       :ref:`glossary`

source/tutorial/manage-mongodb-processes.txt

@@ -1,3 +1,5 @@
+.. _manage-mongodb-processes:
+
 ===========================
 Manage ``mongod`` Processes
 ===========================

source/tutorial/query-documents.txt

@@ -344,7 +344,7 @@ Cursor
 Read Isolation
 ~~~~~~~~~~~~~~
 
-For reads to :doc:`replica sets </replication>` and replica set
+For reads to :ref:`Replica sets <replication>` and replica set
 :doc:`shards </sharding>`, read concern allows clients to choose a
 level of isolation for their reads. For more information, see
 :doc:`/reference/read-concern`.

source/tutorial/rename-unsharded-replica-set.txt

@@ -1,3 +1,5 @@
+.. _rename-a-replica-set:
+
 ====================
 Rename a Replica Set
 ====================

source/tutorial/resync-replica-set-member.txt

@@ -62,18 +62,18 @@ Automatically Sync a Member
    :setting:`~storage.dbPath` directory.
 
 This procedure relies on MongoDB's regular process for
-:doc:`Replica Set Syncing </core/replica-set-sync>`. This stores the current
-data on the member. For an overview of MongoDB initial sync process, see the
-:doc:`Replica Set Syncing </core/replica-set-sync>` section.
+:ref:`Replica Set Syncing <replica-set-sync>`. This stores the current
+data on the member. For an overview of MongoDB initial sync process, see 
+the :ref:`Replica Set Syncing <replica-set-sync>` section.
 
 Initial sync operations can impact the other members of the set and
-create additional traffic to the primary. The syncing member requires another
-member of the set that is accessible and up to date.
+create additional traffic to the primary. The syncing member requires 
+another member of the set that is accessible and up to date.
 
 If the instance has no data, you can follow the
-:doc:`/tutorial/expand-replica-set` or
-:doc:`/tutorial/replace-replica-set-member` procedure to add a new member to a
-replica set.
+:ref:`server-replica-set-deploy-expand` or
+:ref:`server-replica-set-replace-member` procedure to add a new member to 
+a replica set.
 
 You can also force a :binary:`~bin.mongod` that is already a member of the set to
 perform an initial sync by restarting the instance without the contents of the
@@ -93,8 +93,7 @@ perform an initial sync by restarting the instance without the contents of the
 #. Delete all data and sub-directories from the member's
    :setting:`~storage.dbPath` directory.
 
-#. :doc:`Restart the mongod process
-   </tutorial/manage-mongodb-processes>`.
+#. :ref:`Restart the mongod process <manage-mongodb-processes>`.
 
 At this point, the :binary:`~bin.mongod` performs an initial sync. The length of
 the initial sync process depends on the size of the database and the network
@@ -126,7 +125,7 @@ during the file copy operation.
 You *cannot* use a :binary:`~bin.mongodump` backup for the data files:
 **only a snapshot backup**. For approaches to capturing a consistent
 snapshot of a running :binary:`~bin.mongod` instance, see the
-:doc:`/core/backups` documentation.
+:ref:`backup-methods` documentation.
 
 Sync the Member
 ```````````````

source/tutorial/troubleshoot-sharded-clusters.txt

@@ -28,7 +28,7 @@ When a :binary:`~bin.mongos` instance starts, it retrieves a copy of the
 A Single Member Becomes Unavailable in a Shard Replica Set
 ----------------------------------------------------------
 
-:doc:`Replica sets </replication>` provide :term:`high availability` for
+:ref:`Replica sets <replication>` provide :term:`high availability` for
 shards. If the unavailable :binary:`~bin.mongod` is a :term:`primary`,
 then the replica set will :ref:`elect <replica-set-elections>` a new
 primary. If the unavailable :binary:`~bin.mongod` is a
@@ -65,7 +65,7 @@ interruption and attempt to recover the shard as soon as possible.
 A Config Server Replica Set Member Become Unavailable
 -----------------------------------------------------
 
-:doc:`Replica sets </replication>` provide :term:`high availability` for
+Replica sets provide :term:`high availability` for
 the config servers. [#sccc]_ If an unavailable config server is a
 :term:`primary`, then the replica set will 
 :ref:`elect <replica-set-elections>` a new primary.