Docsp 12590 address broken links nextgen (mongodb#9)

* (DOCSP-12590): Fix broken links

* add missing alt tags to figure directives

* unlink mongosniff

* correct mongo shell links

* correct mongod binary link

* remove install_compass link

* link mongo.exe to only mongo binary page

* add missing $ to $[<identifier>] link

* fix lastHeartbeat and lastHeartbeatRecv capitalization in links

* unrelated MONGODB-CR typo fix

* fix exe links

* adds additional missing alt tags to figures

* fix broken [<identifier>] links

* fix members[n] links

* fix connPoolStats.replicaSets.[replicaSets].hosts links

* fix dupe replSetGetStatus.members[n].self entry

* fix dupe readconcern target

* fix glossary term capitalizations

* fix most expression link issues

* fix some authaction links

* remove link attempt to PyMongo for general Python method re.compile

* fix most :setting: links

* mongooplog removed in v3.6

* fix BSON binary type links

* correct sh.status.active-mongoses ambig reference

* fix output example indentation

* fix currentOp ambig targets

* unlink removed cmd authSchemaUpgrade

* unlink removed cmd cloneCollection

* unlink removed cmd closeAllDatabases

* unlink removed cmd copydb

* unlink removed cmd createIndex .. which isn't createIndexes

* fix cmd getLastError

* fix cmd dbHash capitalization

* unlink removed cmd eval

* fix cmd findAndModify capitalization

* fix cmd findAndModify capitalization - another instance

* fix cmd getCollectionInfos to method

* fix cmd getLastError.waited to data

* fix cmd getParameters to singular

* unlink removed cmd indexStats

* fix cmd isSelf to include underscore

* fix cmd listCollection to plural

* fix cmd listDatabase to plural

* fix cmd mongod to binary

* unlink removed cmd planCacheListPlans

* unlink removed cmd planCacheListQueryShapes

* unlink removed cmd repairDatabase

* unlink removed cmd replSetHeartbeat

* fix typo cmd replSetInitiate

* unlink removed cmd restoreDatabase

* unlink removed cmd resync

* fix cmd setParameters to singular

* fix cmd splitAt to method

* fix cmd stats to method

* unlink removed cmd storageDetails

* unlink removed cmd text

* unlink removed cmd touch

* fix method Bulk.find.upsert()

* fix method getKeyVault() malformed link

* unlink removed method PlanCache.getPlansByQuery()

* unlink removed method PlanCache.listQueryShapes()

* fix method Session.getOptions() malformed link

* fix method db.collection.watch() malformed link

* fix method db.copyDatabase() malformed link

* fix method cursor.readPref() malformed link - setReadPref is for a Mongo connection obj

* unlink removed method cursor.showDiskLoc()

* unlink removed method db.addUser()

* unlink removed method db.cloneCollection()

* fix method db.collection.explain() malformed link

* fix method db.help() malformed link

* fix methods db.createRole, db.createUser, db.dropAllUsers malformed definitions, breaking all links

* fix method db.dropUser malformed definition, breaking all links

* fix method db.getMongo() malformed link

* fix method db.serverStatus() malformed link

* fix methods db.grantPrivilegesToRole, db.grantRolesToRole, db.revokePrivilegesFromRole, db.revokeRolesFromRole, db.revokeRolesFromUser malformed definitions, breaking all links

* fix method db.dropAllRoles() malformed link

* fix method db.grantPrivilegesToRole() malformed link

* fix method db.grantRolesToRole() malformed link

* fix method db.grantRolesToUser() malformed definitions, breaking all links, and fix malformed link

* fix method db.revokeRolesFromRole() malformed link

* unlink removed method db.loadServerScripts()

* unlink removed method db.serverShutdown()

* Revert "unlink removed method db.serverShutdown()"

This reverts commit e6a6fd5.

* fix method db.shutdownServer() - wrong in SERVER ticket name

* fix method rs.stepDown() capitalization

* unlink removed method sh.getRecentMigrations

* fix method db.updateRole() malformed link

* fix method db.watch() malformed link

* fix method db.serverStatus() capitalization

* fix method db.getMongo() malformed link

* fix methods db.grantRolesToUser() and db.revokeRolesFromUser() malformed links

* unlink undocumented disableLogicalSessionCacheRefresh param

* unlink removed logicalSessionRefreshMinutes param, update ref to Millis where appropriate

* unlink removed newCollectionsUsePowerOf2Sizes param

* remove test bump

Co-authored-by: jeff-allen-mongo <[email protected]>
Co-authored-by: Andrew Feierabend <[email protected]>

Author: 3 people

README.rst

@@ -2,8 +2,6 @@
 MongoDB Documentation
 =====================
 
-bump
-
 This repository contains a major revision of the MongoDB documentation,
 currently accessible at http://docs.mongodb.com/manual/. You can build
 the documentation locally if you have `giza

source/administration/configuration.txt

@@ -351,7 +351,7 @@ The :setting:`~storage.dbPath` value controls the location of the
 :binary:`~bin.mongod` instance's data directory. Ensure that each database
 has a distinct and well labeled data directory. The
 :setting:`~processManagement.pidFilePath` controls where :binary:`~bin.mongod` process
-places it's :term:`process id <pid>` file. As this tracks the specific
+places it's :term:`process id (PID) <PID>` file. As this tracks the specific
 :binary:`~bin.mongod` file, it is crucial that file be unique and well
 labeled to make it easy to start and stop these processes.
 

source/changeStreams.txt

@@ -567,7 +567,7 @@ document.
 
          To return the most current majority-committed version of the updated
          document, pass ``"FullDocument = ChangeStreamFullDocumentOption.UpdateLookup"`` to the
-         ``collection.Watch()`` method.
+         :method:`db.collection.watch()` method.
 
          In the example below, all update operations notifications
          include a ``FullDocument`` field that represents the *current*
@@ -585,7 +585,7 @@ document.
 
          To return the most current majority-committed version of the updated
          document, pass ``{ fullDocument: 'updateLookup' }`` to the
-         :method:`collection.watch()` method.
+         :method:`db.collection.watch()` method.
 
          In the example below, all update operations notifications
          include a ``fullDocument`` field that represents the *current*
@@ -613,7 +613,7 @@ document.
          To return the most current
          majority-committed version of the updated document, pass
          ``"fullDocument' => \MongoDB\Operation\ChangeStreamCommand::FULL_DOCUMENT_UPDATE_LOOKUP"``
-         to the :method:`watch()` method.
+         to the :method:`db.watch()` method.
 
          In the example below, all update operations notifications
          include a ``fullDocument`` field that represents the *current*
@@ -629,7 +629,7 @@ document.
         content: |
          To return the most current majority-committed version of the updated
          document, pass ``full_document: 'updateLookup'`` to the
-         :method:`watch()` method.
+         :method:`db.watch()` method.
 
          In the example below, all update operations notifications
          include a ``full_document`` field that represents the *current*

source/core/document.txt

@@ -143,7 +143,7 @@ For examples querying arrays, see:
 
    - :update:`$[]` all positional operator for update operations,
 
-   - :update:`$[/<identifier/>]` filtered positional operator for update operations,
+   - :update:`$[\<identifier\>]` filtered positional operator for update operations,
 
    - :update:`$` positional operator for update operations,
 

source/core/hashed-sharding.txt

@@ -65,7 +65,7 @@ The field you choose as your hashed shard key should have a good
 Hashed keys are ideal for shard keys with fields that change
 :ref:`monotonically<shard-key-monotonic>` like :term:`ObjectId` values or
 timestamps. A good example of this is the default ``_id`` field, assuming
-it only contains :term:`ObjectID` values.
+it only contains :term:`ObjectId` values.
 
 To shard a collection using a hashed shard key, see
 :ref:`deploy-hashed-sharded-cluster-shard-collection`.

source/core/index-ttl.txt

@@ -57,7 +57,7 @@ If the field is an array, and there are multiple date values in the
 index, MongoDB uses *lowest* (i.e. earliest) date value in the array to
 calculate the expiration threshold.
 
-If the indexed field in a document is not a :term:`date <bson types>`
+If the indexed field in a document is not a :term:`date <BSON types>`
 or an array that holds a date value(s), the document will not expire.
 
 If a document does not contain the indexed field, the document will not
@@ -87,7 +87,7 @@ Replica Sets
 
 On :term:`replica set <replica set>` members, the TTL background thread *only*
 deletes documents when a member is in state :term:`primary`. The TTL background
-thread is idle when a member is in state :term:`secondary`. :term:`Secondary` members replicate
+thread is idle when a member is in state :term:`secondary`. :term:`Secondary <secondary>` members replicate
 deletion operations from the primary.
 
 Support for Queries

source/core/query-plans.txt

@@ -201,11 +201,11 @@ The ``queryHash`` and ``planCacheKey`` are available in:
 
 - :pipeline:`$planCacheStats` aggregation stage (*New in MongoDB 4.2*)
 
-- :method:`PlanCache.listQueryShapes()`
-  method/:dbcommand:`planCacheListQueryShapes` command
+- ``PlanCache.listQueryShapes()``
+  method/``planCacheListQueryShapes`` command
 
-- :method:`PlanCache.getPlansByQuery()`
-  method/:dbcommand:`planCacheListPlans` command
+- ``PlanCache.getPlansByQuery()``
+  method/``planCacheListPlans`` command
 
 .. _index-filters:
 

source/core/security-client-side-encryption.txt

@@ -66,7 +66,7 @@ Consider the following document:
 With client-side field level encryption, the application can 
 specifically encrypt sensitive information like the ``ssn``
 and ``phone``. Encrypted fields are stored as
-:bsontype:`binary data <data_binary>` with 
+:bsontype:`binary data <Binary>` with 
 `subtype 6 <https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/subtype6.rst>`_:
 
 .. code-block:: json
@@ -300,7 +300,7 @@ collection. Use the :ref:`automatic encryption rule keywords
 <field-level-encryption-json-schema>` with the
 :query:`$jsonSchema` validation object to indicate which fields require
 encryption. The server rejects any write operations to that collection
-where the specified fields are not :bsontype:`Binary (BinData) <binary>`
+where the specified fields are not :bsontype:`Binary (BinData) <Binary>`
 subtype 6 objects.
 
 For example, the following :dbcommand:`collMod` command modifies

source/core/security-ldap-external.txt

@@ -293,7 +293,7 @@ configuration file:
 
        Defaults to ``DIGEST-MD5``.
 
-     - **NO**, unless setting :setting:`~security.ldap.bindMethod` to
+     - **NO**, unless setting :setting:`~security.ldap.bind.method` to
        ``sasl``, and you need different or additional SASL mechanisms.
 
    * - :setting:`security.ldap.bind.useOSDefaults`
@@ -308,10 +308,11 @@ configuration file:
 
    * - :setting:`security.ldap.userToDNMapping`
 
-     - Depending on your :setting:`~security.ldap.queryTemplate`, the
-       authenticated client username may require transformation to support the
-       LDAP query URL. :setting:`~security.ldap.userToDNMapping` allows
-       MongoDB to transform incoming usernames.
+     - Depending on your :setting:`~security.ldap.authz.queryTemplate`,
+       the authenticated client username may require transformation to
+       support the LDAP query URL.
+       :setting:`~security.ldap.userToDNMapping` allows MongoDB to
+       transform incoming usernames.
 
      - **NO**, unless client usernames require transformation into LDAP DNs.
 
@@ -446,7 +447,7 @@ MongoDB Roles for LDAP Authorization
 ------------------------------------
 
 MongoDB maps each returned group distinguished name (DN) returned by
-the LDAP :setting:`query <ldap.security.authz.queryTemplate>` to a
+the LDAP :setting:`query <security.ldap.authz.queryTemplate>` to a
 :ref:`role <authorization>` on the ``admin`` database.
 
 If MongoDB acquires a group whose DN **exactly** matches the name of an
@@ -494,7 +495,7 @@ privileges to the user.
    After authenticating a user ``[email protected]`` against the
    ``$external`` database, the MongoDB server performs a query derived from
    the configured :setting:`query template
-   <ldap.security.authz.queryTemplate>` to retrieve the groups which include
+   <security.ldap.authz.queryTemplate>` to retrieve the groups which include
    the authenticated user as a member. In this example, the MongoDB server
    retrieves the following group DNs for the user:
 

source/core/security-ldap.txt

@@ -262,13 +262,14 @@ configuration file:
      - The password used to authenticate to an LDAP server when using
        :setting:`~security.ldap.bind.queryUser`.
 
-     - **NO**, unless specifying :setting:`~security.ldap.queryUser`
+     - **NO**, unless specifying
+       :setting:`~security.ldap.bind.queryUser`.
 
    * - :setting:`security.ldap.bind.useOSDefaults`
 
      - Windows MongoDB deployments can use the operating system credentials in
-       place of :setting:`~security.ldap.queryUser` and
-       :setting:`~security.ldap.queryPassword` for authenticating or binding
+       place of :setting:`~security.ldap.bind.queryUser` and
+       :setting:`~security.ldap.bind.queryPassword` for authenticating or binding
        as when connecting to the LDAP server.
 
      - **NO**, unless replacing :setting:`~security.ldap.bind.queryUser` and
@@ -288,9 +289,10 @@ configuration file:
        or an LDAP query template.
 
        If you specify a :setting:`~security.ldap.userToDNMapping`
-       transformation that uses LDAP queries as part of the transformation,
-       you must also specify a :setting:`~security.ldap.queryUser` with
-       the appropriate level of permissions for the LDAP server
+       transformation that uses LDAP queries as part of the
+       transformation, you must also specify a
+       :setting:`~security.ldap.bind.queryUser` with the appropriate
+       level of permissions for the LDAP server
 
      - **NO**, unless client authenticate using usernames that require
        transformation.

source/core/sharded-cluster-shards.txt

@@ -42,7 +42,7 @@ replica set.
 The :binary:`~bin.mongos` selects the primary shard when creating a new database
 by picking the shard in the cluster that has the least amount of data.
 :binary:`~bin.mongos` uses the ``totalSize`` field returned by the
-:dbcommand:`listDatabase` command as a part of the selection criteria.
+:dbcommand:`listDatabases` command as a part of the selection criteria.
 
 .. include:: /images/sharded-cluster-primary-shard.rst
 

source/geospatial-queries.txt

@@ -98,7 +98,7 @@ collections:
 .. |geo-operation| replace:: :query:`$near` and :query:`$nearSphere`
 
 You can also query for geospatial data for a sharded cluster using
-:query:`$geoWithin` and :query:`$geoIntersect`.
+:query:`$geoWithin` and :query:`$geoIntersects`.
 
 Covered Queries
 ~~~~~~~~~~~~~~~
@@ -341,7 +341,7 @@ farthest:
       }
    )
 
-The following operation uses the :pipeline:`geoNear` aggregation
+The following operation uses the :pipeline:`$geoNear` aggregation
 operation to return documents that match the query filter ``{ category:
 "Parks" }``, sorted in order of nearest to farthest to the specified
 GeoJSON point:

source/includes/access-change-password.rst

@@ -1,3 +1,3 @@
 To modify the password of another user on a database, you must have the
-:authaction:`changeAnyPassword` :ref:`action <security-user-actions>`
+:authaction:`changePassword` :ref:`action <security-user-actions>`
 on that database.

source/includes/access-update-user.rst

@@ -6,5 +6,5 @@ You must have the :authaction:`grantRole` :ref:`action
 <security-user-actions>` on a role's database to add a role to a user.
 
 To change another user's ``pwd`` or ``customData`` field, you must have
-the :authaction:`changeAnyPassword` and :authaction:`changeAnyCustomData`
+the :authaction:`changePassword` and :authaction:`changeCustomData`
 :ref:`actions <security-user-actions>` respectively on that user's database.

source/includes/considerations-deploying-replica-set.rst

@@ -14,8 +14,9 @@ Hostnames
 IP Binding
 ~~~~~~~~~~
 
-Use the :setting:`bind_ip` option to ensure that MongoDB listens for
-connections from applications on configured addresses.
+Use the :option:`--bind_ip <mongod --bind_ip>` option to ensure that
+MongoDB listens for connections from applications on configured
+addresses.
 
 .. versionchanged:: 3.6
 

source/includes/driver-examples/driver-example-delete-58.rst

@@ -15,6 +15,7 @@
             to access the :ref:`Table View <documents-table-view>`:
 
             .. figure:: /images/compass-table-btn-click-2.png
+               :alt: Compass Table View button
 
             .. raw:: html
 
@@ -32,6 +33,7 @@
                { item: "paper" }
 
             .. figure:: /images/compass-delete-paper-find.png
+               :alt: Compass Find button
 
             .. raw:: html
 
@@ -45,6 +47,7 @@
                <br>
 
             .. figure:: /images/compass-delete-button-click.png
+               :alt: Compass Delete Document button
 
             .. raw:: html
 
@@ -59,6 +62,7 @@
                <br>
 
             .. figure:: /images/compass-delete-confirm.png
+               :alt: Compass Confirm Deletion button
 
             .. raw:: html
 

source/includes/driver-examples/driver-example-insert-1.rst

@@ -17,6 +17,7 @@
      - id: compass
        content: |
          .. figure:: /images/compass-insert-document-inventory.png
+            :alt: Compass insert new document into collection
 
      - id: python
        content: |

source/includes/driver-examples/driver-example-insert-2.rst

@@ -11,6 +11,7 @@
      - id: compass
        content: |
          .. figure:: /images/compass-query-collection.png
+            :alt: Query for matching documents in a collection
 
          Specify a filter in the MongoDB Compass query bar and click
          :guilabel:`Find` to execute the query.

source/includes/driver-examples/driver-example-query-10.rst

@@ -19,6 +19,7 @@
             { status: { $in: [ "A", "D" ] } }
 
          .. figure:: /images/compass-find-filter-query-op.png
+            :alt: Query using query operators
 
      - id: python
        content: |

source/includes/driver-examples/driver-example-query-11.rst

@@ -19,6 +19,7 @@
             { status: "A", qty: { $lt: 30 } }
 
          .. figure:: /images/compass-find-filter-and.png
+            :alt: Query using multiple conditions with AND
 
      - id: python
        content: |

source/includes/driver-examples/driver-example-query-12.rst

@@ -19,6 +19,7 @@
             { $or: [ { status: "A" }, { qty: { $lt: 30 } } ] }
 
          .. figure:: /images/compass-find-filter-or.png
+            :alt: Query using OR
 
      - id: python
        content: |

source/includes/driver-examples/driver-example-query-13.rst

@@ -22,6 +22,7 @@
             { status: "A", $or: [ { qty: { $lt: 30 } }, { item: /^p/ } ] }
 
          .. figure:: /images/compass-find-filter-and-or.png
+            :alt: Query using AND as well as OR
 
 
      - id: python

source/includes/driver-examples/driver-example-query-15.rst

@@ -19,6 +19,7 @@
             { size: { h: 14, w: 21, uom: "cm" } }
 
          .. figure:: /images/compass-match-embedded.png
+            :alt: Query embedded field
 
      - id: python
        content: |

source/includes/driver-examples/driver-example-query-16.rst

@@ -11,6 +11,7 @@
      - id: compass
        content: |
          .. figure:: /images/compass-find-embedded-no-match.png
+            :alt: Query embedded field
 
      - id: python
        content: |

source/includes/driver-examples/driver-example-query-17.rst

@@ -19,6 +19,7 @@
             { "size.uom": "in" }
 
          .. figure:: /images/compass-find-nested-field.png
+            :alt: Query single nested field
 
      - id: python
        content: |

source/includes/driver-examples/driver-example-query-18.rst

@@ -19,6 +19,7 @@
             { "size.h": { $lt: 15 } }
 
          .. figure:: /images/compass-find-nested-query-op.png
+            :alt: Query single nested field
 
      - id: python
        content: |

source/includes/driver-examples/driver-example-query-19.rst

@@ -19,6 +19,7 @@
             { "size.h": { $lt: 15 }, "size.uom": "in", status: "D" }
 
          .. figure:: /images/compass-find-embedded-and.png
+            :alt: Query multiple nested fields
 
      - id: python
        content: |

source/includes/driver-examples/driver-example-query-21.rst

@@ -19,6 +19,7 @@
             { tags: ["red", "blank"] }
 
          .. figure:: /images/compass-array-match-exact.png
+            :alt: Query array matching exactly
 
      - id: python
        content: |

source/includes/driver-examples/driver-example-query-22.rst

@@ -19,6 +19,7 @@
             { tags: { $all: ["red", "blank"] } }
 
          .. figure:: /images/compass-array-match-all.png
+            :alt: Query array matching all criteria
 
      - id: python
        content: |

source/includes/driver-examples/driver-example-query-23.rst

@@ -19,6 +19,7 @@
             { tags: "red" }
 
          .. figure:: /images/compass-array-elem-match.png
+            :alt: Query array matching multiple criteria
 
      - id: python
        content: |