DOCSP-26428 Replace Getting Started Guide-LDAP Proxy doc directives (#2165)

jmd-mongo · web-flow · commit 48684019af48 · 2022-11-18T17:15:57.000-05:00
* DOCSP-26428 Replace Getting Started Guide-LDAP Proxy doc directives * internal review feedback
diff --git a/source/administration/production-checklist-development.txt b/source/administration/production-checklist-development.txt
@@ -29,7 +29,7 @@ Data Durability
      </reference/write-concern>`. Three data-bearing nodes are
      required for replica-set wide data durability.
 
-   - Ensure that all instances use :doc:`journaling </core/journaling>`.
+   - Ensure that all instances use :ref:`journaling <journaling-internals>`.
 
 Schema Design
 ~~~~~~~~~~~~~
@@ -61,7 +61,7 @@ structures. See :doc:`/core/data-models` for more information.
 
    - Consider the document size limits when designing your schema.
      The :limit:`BSON Document Size` limit is 16MB per document. If
-     you require larger documents, use :doc:`GridFS </core/gridfs>`.
+     you require larger documents, use :ref:`GridFS <gridfs>`.
 
 Replication
 ~~~~~~~~~~~
diff --git a/source/administration/production-checklist-operations.txt b/source/administration/production-checklist-operations.txt
@@ -130,7 +130,7 @@ Journaling: WiredTiger Storage Engine
 
 .. cssclass:: checklist
 
-   - Ensure that all instances use :doc:`journaling </core/journaling>`.
+   - Ensure that all instances use :ref:`journaling <journaling-internals>`.
 
    - Place the journal on its own low-latency disk for write-intensive
      workloads. Note that this will affect snapshot-style backups as
diff --git a/source/core/authentication.txt b/source/core/authentication.txt
@@ -83,7 +83,7 @@ Kerberos Authentication
 <http://www.mongodb.com/products/mongodb-enterprise-advanced?tck=docs_server>`_
 and `MongoDB Atlas
 <https://www.mongodb.com/cloud/atlas?tck=docs_server>`__ support
-:doc:`Kerberos Authentication </core/kerberos>`. Kerberos is an industry
+:ref:`Kerberos Authentication <security-kerberos>`. Kerberos is an industry
 standard authentication protocol for large client/server systems that
 provides authentication using short-lived tokens that are called
 tickets.
@@ -95,7 +95,7 @@ principal <kerberos-user-principal>` added to MongoDB.
 
 For more information on Kerberos and MongoDB, see:
 
-- :doc:`Kerberos Authentication </core/kerberos>`
+- :ref:`Kerberos Authentication <security-kerberos>`
 - :doc:`/tutorial/control-access-to-mongodb-with-kerberos-authentication`
 - :doc:`/tutorial/control-access-to-mongodb-windows-with-kerberos-authentication`
 
@@ -108,13 +108,13 @@ LDAP Proxy Authentication
 <http://www.mongodb.com/products/mongodb-enterprise-advanced?tck=docs_server>`_
 and `MongoDB Atlas
 <https://www.mongodb.com/cloud/atlas?tck=docs_server>`__ support
-:doc:`LDAP Proxy Authentication </core/security-ldap>` proxy
+:ref:`LDAP Proxy Authentication <security-ldap>` proxy
 authentication through a Lightweight Directory Access Protocol (LDAP)
 service.
 
 For more information on Kerberos and MongoDB, see:
 
-- :doc:`LDAP Proxy Authentication </core/security-ldap>`
+- :ref:`LDAP Proxy Authentication <security-ldap>`
 - :doc:`/tutorial/configure-ldap-sasl-activedirectory`
 - :doc:`/tutorial/configure-ldap-sasl-openldap`
 - :doc:`/tutorial/authenticate-nativeldap-activedirectory`
diff --git a/source/core/index-multikey.txt b/source/core/index-multikey.txt
@@ -151,7 +151,7 @@ Compound multikey indexes can have an impact on performance.
 Hashed Indexes
 ~~~~~~~~~~~~~~
 
-:doc:`Hashed </core/index-hashed>` indexes **cannot** be multikey.
+:ref:`Hashed indexes <index-hashed-index>` **cannot** be multikey.
 
 Covered Queries
 ~~~~~~~~~~~~~~~
diff --git a/source/core/replica-set-architectures.txt b/source/core/replica-set-architectures.txt
@@ -178,7 +178,7 @@ concern to request acknowledgement from specific members.
 Use Journaling to Protect Against Power Failures
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-MongoDB enables :doc:`journaling </core/journaling>` by default.
+MongoDB enables :ref:`journaling <journaling-internals>` by default.
 Journaling protects against data loss in the event of service
 interruptions, such as power failures and unexpected reboots.
 
diff --git a/source/core/storage-engines.txt b/source/core/storage-engines.txt
@@ -35,8 +35,8 @@ applications.
    :ref:`encrypted-storage-engine`.
 
 |arrow| In-Memory Storage Engine
-   :doc:`In-Memory Storage Engine </core/inmemory>` is available in
-   MongoDB Enterprise. Rather than storing documents on-disk, it
+   An :ref:`In-Memory storage engine <storage-inmemory>` is available 
+   in MongoDB Enterprise. Rather than storing documents on-disk, it
    retains them in-memory for more predictable data latencies.
 
 .. toctree::
diff --git a/source/includes/driver-examples/driver-example-delete-55.rst b/source/includes/driver-examples/driver-example-delete-55.rst
@@ -31,7 +31,7 @@
             ]
 
          For instructions on inserting documents in MongoDB Compass, see
-         :doc:`Insert Documents </tutorial/insert-documents/>`.
+         :ref:`Insert Documents <write-op-insert>`.
 
          .. note::
 
diff --git a/source/includes/driver-examples/driver-example-insert-3.rst b/source/includes/driver-examples/driver-example-insert-3.rst
@@ -35,7 +35,7 @@
             ]
 
          For instructions on inserting documents using |compass|, see
-         :doc:`Insert Documents </tutorial/insert-documents/>`.
+         :ref:`Insert Documents <write-op-insert>`.
 
      - id: python
        content: |
diff --git a/source/includes/driver-examples/driver-example-query-14.rst b/source/includes/driver-examples/driver-example-query-14.rst
@@ -31,7 +31,7 @@
             ]
 
          For instructions on inserting documents in MongoDB Compass, see
-         :doc:`Insert Documents </tutorial/insert-documents/>`.
+         :ref:`Insert Documents <write-op-insert>`.
 
      - id: python
        content: |
diff --git a/source/includes/driver-examples/driver-example-query-20.rst b/source/includes/driver-examples/driver-example-query-20.rst
@@ -31,7 +31,7 @@
             ]
 
          For instructions on inserting documents in MongoDB Compass, see
-         :doc:`Insert Documents </tutorial/insert-documents/>`.
+         :ref:`Insert Documents <write-op-insert>`.
 
 
      - id: python
diff --git a/source/includes/driver-examples/driver-example-query-29.rst b/source/includes/driver-examples/driver-example-query-29.rst
@@ -31,7 +31,7 @@
             ]
 
          For instructions on inserting documents in MongoDB Compass, see
-         :doc:`Insert Documents </tutorial/insert-documents/>`.
+         :ref:`Insert Documents <write-op-insert>`.
 
      - id: python
        content: |
diff --git a/source/includes/driver-examples/driver-example-query-38.rst b/source/includes/driver-examples/driver-example-query-38.rst
@@ -27,7 +27,7 @@
             ]
 
          For instructions on inserting documents in MongoDB Compass, see
-         :doc:`Insert Documents </tutorial/insert-documents/>`.
+         :ref:`Insert Documents <write-op-insert>`.
 
      - id: python
        content: |
diff --git a/source/includes/driver-examples/driver-example-query-6.rst b/source/includes/driver-examples/driver-example-query-6.rst
@@ -31,7 +31,7 @@
             ]
 
          For instructions on inserting documents in MongoDB Compass, see
-         :doc:`Insert Documents </tutorial/insert-documents/>`.
+         :ref:`Insert Documents <write-op-insert>`.
 
      - id: python
        content: |
diff --git a/source/includes/driver-examples/driver-example-update-51.rst b/source/includes/driver-examples/driver-example-update-51.rst
@@ -41,7 +41,7 @@
             ]
 
          For instructions on inserting documents using |compass|, see
-         :doc:`Insert Documents </tutorial/insert-documents/>`.
+         :ref:`Insert Documents <write-op-insert>`.
 
      - id: python
        content: |
diff --git a/source/includes/extracts-4.2-changes.yaml b/source/includes/extracts-4.2-changes.yaml
@@ -499,7 +499,7 @@ content: |
 ref: 4.2-changes-inmem-startup-warning
 content: |
    Starting in version 4.2 (and 4.0.13 and 3.6.14 ), if a replica set
-   member uses the :doc:`in-memory storage engine </core/inmemory>`
+   member uses the :ref:`in-memory storage engine <storage-inmemory>`
    (voting or non-voting) but the replica set has
    :rsconf:`writeConcernMajorityJournalDefault` set to true, the
    replica set member logs a startup warning.
diff --git a/source/includes/not-available-for-inmemory-storage-engine.rst b/source/includes/not-available-for-inmemory-storage-engine.rst
@@ -1,2 +1,2 @@
 Not available for :binary:`~bin.mongod` instances that use the
-:doc:`in-memory storage engine </core/inmemory>`.
+:ref:`in-memory storage engine <storage-inmemory>`.
diff --git a/source/indexes.txt b/source/indexes.txt
@@ -259,7 +259,7 @@ Hidden Indexes
 
 .. versionadded:: 4.4
 
-:doc:`Hidden indexes </core/index-hidden>` are not visible to the
+:ref:`Hidden indexes <index-type-hidden>` are not visible to the
 :doc:`query planner </core/query-plans>` and cannot be used to support
 a query.
 
diff --git a/source/query-api.txt b/source/query-api.txt
@@ -82,6 +82,6 @@ Getting Started
 ---------------
 
 To get started, visit the MongoDB 
-:doc:`Getting Started Guide </tutorial/getting-started>`. Here you can
+:ref:`Getting Started Guide <getting-started>`. Here you can
 find resources, code examples and tutorials that demonstrate the MongoDB
 |query-api|.
diff --git a/source/reference/command/createIndexes.txt b/source/reference/command/createIndexes.txt
@@ -177,7 +177,7 @@ Each document in the ``indexes`` array can take the following fields:
        MongoDB supports several different index types including
        :ref:`text <index-feature-text>`, :ref:`geospatial
        <index-feature-geospatial>`, and :ref:`hashed
-       <index-type-hashed>` indexes. See :ref:`index types <index-types>`
+       indexes <index-type-hashed>`. See :ref:`index types <index-types>`
        for more information.
        
        .. versionchanged:: 4.2
@@ -256,7 +256,7 @@ Each document in the ``indexes`` array can take the following fields:
        Specify ``true`` to create a unique index. The
        default value is ``false``.
        
-       The option is *unavailable* for :doc:`hashed </core/index-hashed>`
+       The option is *unavailable* for :ref:`hashed <index-hashed-index>`
        indexes.
        
        
diff --git a/source/reference/command/listIndexes.txt b/source/reference/command/listIndexes.txt
@@ -17,7 +17,7 @@ Definition
 
    Returns information about the indexes on the specified collection. Returned 
    index information includes the keys and options used to create the index, as 
-   well as :doc:`hidden indexes </core/index-hidden>`. You can optionally set 
+   well as :ref:`hidden indexes <index-type-hidden>`. You can optionally set 
    the batch size for the first batch of results. 
 
    .. |method| replace:: :method:`db.collection.getIndexes()` helper method
diff --git a/source/reference/method/db.collection.createIndex.txt b/source/reference/method/db.collection.createIndex.txt
@@ -51,8 +51,8 @@ Definition
           MongoDB supports several different index types including
           :ref:`text <index-feature-text>`, :ref:`geospatial
           <index-feature-geospatial>`, and :ref:`hashed
-          <index-type-hashed>` indexes. See :ref:`index types <index-types>`
-          for more information.
+          indexes <index-type-hashed>`. See :ref:`index types 
+          <index-types>` for more information.
           
           .. versionchanged:: 4.2
           
@@ -207,7 +207,7 @@ otherwise specified:
        default value is ``false``.
        
        The option is *unavailable* for 
-       :doc:`hashed </core/index-hashed>` indexes.
+       :ref:`hashed indexes <index-hashed-index>`.
        
        
        
diff --git a/source/reference/method/db.collection.createIndexes.txt b/source/reference/method/db.collection.createIndexes.txt
@@ -225,8 +225,8 @@ otherwise specified:
        Specify ``true`` to create a unique index. The
        default value is ``false``.
        
-       The option is *unavailable* for :doc:`hashed </core/index-hashed>`
-       indexes.
+       The option is *unavailable* for :ref:`hashed indexes 
+       <index-hashed-index>`.
        
        
        
diff --git a/source/reference/method/db.collection.getIndexes.txt b/source/reference/method/db.collection.getIndexes.txt
@@ -22,7 +22,7 @@ Definition
 
    Returns an array that holds a list of documents that identify and
    describe the existing indexes on the collection, including
-   :doc:`hidden indexes </core/index-hidden>`. 
+   :ref:`hidden indexes <index-type-hidden>`. 
 
    You must call
    :method:`db.collection.getIndexes()` on a collection. For example:
diff --git a/source/release-notes/1.8.txt b/source/release-notes/1.8.txt
@@ -211,7 +211,7 @@ Journaling
 ``````````
 
 Returning to 1.6 after using 1.8
-:doc:`Journaling </core/journaling>` works
+:ref:`Journaling <journaling-internals>` works
 fine, as journaling does not change anything about the data file format.
 Suppose you are running 1.8.x with journaling enabled and you decide to
 switch back to 1.6. There are two scenarios:
@@ -306,7 +306,7 @@ Additional Changes and Enhancements
 
 1.7.5
 `````
-- :doc:`Journaling </core/journaling>`.
+- :ref:`Journaling <journaling-internals>`.
 
 - Extent allocation improvements.
 
diff --git a/source/release-notes/4.2.txt b/source/release-notes/4.2.txt
@@ -590,12 +590,12 @@ Distributed transactions:
   total size limit for a transaction.
 
 - Extends transaction support to deployments whose secondary members
-  use the :doc:`in-memory storage engine </core/inmemory>`. That is,
+  use the :ref:`in-memory storage engine <storage-inmemory>`. That is,
   transactions are available for deployments that use the WiredTiger
   storage engine for the primary and either the WiredTiger or the
-  :doc:`in-memory </core/inmemory>` storage engine for the secondary
-  members. In MongoDB 4.0, transactions are available for deployments
-  that use the WiredTiger storage engine only.
+  in-memory storage engine for the secondary members. In MongoDB 4.0, 
+  transactions are available for deployments that use the WiredTiger 
+  storage engine only.
 
 For more information, see :doc:`/core/transactions`.
 
diff --git a/source/release-notes/4.4.txt b/source/release-notes/4.4.txt
@@ -1784,7 +1784,7 @@ unhidden.
 
 For details, see :doc:`/core/index-hidden`.
 
-To support :doc:`hidden indexes </core/index-hidden>`, MongoDB
+To support :ref:`Hidden indexes <index-type-hidden>`, MongoDB
 introduces:
 
 - A new index option ``hidden``. The option can be specified in the
diff --git a/source/tutorial/deploy-replica-set-with-keyfile-access-control.txt b/source/tutorial/deploy-replica-set-with-keyfile-access-control.txt
@@ -19,7 +19,7 @@ Overview
 Enforcing access control on a :term:`replica set` requires configuring:
 
 - Security between members of the replica set using
-  :doc:`Internal Authentication</core/security-internal-authentication>`, and
+  :ref:`Internal Authentication<replica-set-security>`, and
 
 - Security between connecting clients and the replica set using
   :doc:`/core/authorization`.
diff --git a/source/tutorial/deploy-sharded-cluster-with-keyfile-access-control.txt b/source/tutorial/deploy-sharded-cluster-with-keyfile-access-control.txt
@@ -16,7 +16,7 @@ Overview
 Enforcing access control on a :term:`sharded cluster` requires configuring:
 
 - Security between components of the cluster using
-  :doc:`Internal Authentication</core/security-internal-authentication>`.
+  :ref:`Internal Authentication<replica-set-security>`.
 
 - Security between connecting clients and the cluster using
   :doc:`User Access Controls</core/authorization>`.
diff --git a/source/tutorial/enforce-keyfile-access-control-in-existing-replica-set.txt b/source/tutorial/enforce-keyfile-access-control-in-existing-replica-set.txt
@@ -17,7 +17,7 @@ Enforcing access control on an existing :term:`replica set` requires
 configuring:
 
 - Security between members of the replica set using
-  :doc:`Internal Authentication</core/security-internal-authentication>`, and
+  :ref:`Internal Authentication<replica-set-security>`, and
 
 - Security between connecting clients and the replica set using
   :doc:`User Access Controls</core/authorization>`.
diff --git a/source/tutorial/enforce-keyfile-access-control-in-existing-sharded-cluster.txt b/source/tutorial/enforce-keyfile-access-control-in-existing-sharded-cluster.txt
@@ -16,7 +16,7 @@ Overview
 Enforcing access control on a :term:`sharded cluster` requires configuring:
 
 - Security between components of the cluster using
-  :doc:`Internal Authentication</core/security-internal-authentication>`.
+  :ref:`Internal Authentication<replica-set-security>`.
 
 - Security between connecting clients and the cluster using
   :doc:`/core/authorization`.

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@`
`31`	`31`	`]`
`32`	`32`
`33`	`33`	`For instructions on inserting documents in MongoDB Compass, see`
`34`		- :doc:`Insert Documents </tutorial/insert-documents/>`.
	`34`	+ :ref:`Insert Documents <write-op-insert>`.
`35`	`35`
`36`	`36`	`.. note::`
`37`	`37`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@`
`35`	`35`	`]`
`36`	`36`
`37`	`37`	`For instructions on inserting documents using \|compass\|, see`
`38`		- :doc:`Insert Documents </tutorial/insert-documents/>`.
	`38`	+ :ref:`Insert Documents <write-op-insert>`.
`39`	`39`
`40`	`40`	`- id: python`
`41`	`41`	`content: \|`