DOCSP-26288 replaces auditing-related doc directives (#2102)

jmd-mongo · web-flow · commit 125d52e21432 · 2022-11-02T15:10:55.000-04:00
* DOCSP-26288 replaces auditing-realted doc directives * internal review feedback * internal review feedback
diff --git a/source/core/transactions-production-consideration.txt b/source/core/transactions-production-consideration.txt
@@ -140,7 +140,7 @@ Transactions and Security
   have :doc:`privileges </reference/built-in-roles>` for the
   :ref:`operations in the transaction <transactions-operations>`.
 
-- If running with :doc:`auditing </core/auditing>`, operations in an
+- If running with :ref:`auditing <auditing>`, operations in an
   aborted transaction are still audited. However, there is no audit
   event that indicates that the transaction aborted.
 
diff --git a/source/includes/steps-log-rotate-rename.yaml b/source/includes/steps-log-rotate-rename.yaml
@@ -32,7 +32,7 @@ action:
   code: |
     db.adminCommand( { logRotate : "server" } )
 post: |
-  If :doc:`auditing </core/auditing>` is enabled, you can specify ``1``
+  If :ref:`auditing <auditing>` is enabled, you can specify ``1``
   to ``logRotate`` (instead of  ``server``) to rotate both the server
   and audit logs at the same time, if desired. The audit log will be
   rotated in the same fashion as the server log, according to the
diff --git a/source/reference/command/abortTransaction.txt b/source/reference/command/abortTransaction.txt
@@ -60,6 +60,6 @@ transaction ends.
 Security
 ~~~~~~~~
 
-If running with :doc:`auditing </core/auditing>`, operations in an
+If running with :ref:`auditing <auditing>`, operations in an
 aborted transaction are still audited.
   
diff --git a/source/reference/command/getAuditConfig.txt b/source/reference/command/getAuditConfig.txt
@@ -37,7 +37,7 @@ The command has the following syntax:
 Behavior
 --------
 
-:doc:`Auditing </core/auditing>` must be enabled in order to use
+:ref:`Auditing <auditing>` must be enabled to use
 :dbcommand:`getAuditConfig`.
 
 Nodes that are not participating in a runtime audit configuration
@@ -53,8 +53,8 @@ quickly. However, the distribution mechanism is different on
 :parameter:`poll <auditConfigPollingFrequencySecs>` the primary server
 at regular intervals for configuration updates. You may see stale data
 due to polling delay if you run :dbcommand:`setAuditConfig` on the
-primary server and :dbcommand:`getAuditConfig` on a
-:doc:`shard </sharding>` before the shard has polled the primary server
+primary server and :dbcommand:`getAuditConfig` on a :ref:`shard 
+<sharding-introduction>` before the shard has polled the primary server
 for updated configuration details.
 
 .. note::
diff --git a/source/reference/command/logRotate.txt b/source/reference/command/logRotate.txt
@@ -79,8 +79,7 @@ Limitations
   :option:`--logpath [file] <mongod --logpath>` option in order to use
   :dbcommand:`logRotate`
 
-- :doc:`Auditing </core/auditing>` must be enabled in order to rotate
-  the audit log.
+- :ref:`Auditing <auditing>` must be enabled to rotate the audit log.
 
 Behavior
 --------
diff --git a/source/reference/command/rotateCertificates.txt b/source/reference/command/rotateCertificates.txt
@@ -147,7 +147,7 @@ Logging
 On successful rotation, the subject names, thumbprints, and the
 validity period of the server and cluster certificate thumbprints are
 logged to the configured :ref:`log destination
-<log-message-destinations>`. If :doc:`auditing </core/auditing>` is
+<log-message-destinations>`. If :ref:`auditing <auditing>` is
 enabled, this information is also written to the audit log.
 
 On Linux and Windows platforms, if a :setting:`CRL file
diff --git a/source/reference/command/setAuditConfig.txt b/source/reference/command/setAuditConfig.txt
@@ -59,7 +59,7 @@ The command has the following fields:
  
    * - ``filter``
      - document
-     - An :doc:`audit filter </tutorial/configure-audit-filters>`
+     - An :ref:`audit filter <audit-filter>`
  
    * - ``auditAuthorizationSuccess``
      - boolean
@@ -69,16 +69,16 @@ The command has the following fields:
 Behavior
 --------
 
-Enable :doc:`Auditing </core/auditing>` to use
+Enable :ref:`auditing <auditing>` to use
 :dbcommand:`setAuditConfig` at runtime.
 
-:parameter:`auditAuthorizationSuccess` enables :doc:`auditing
-</core/auditing>` of authorization success for the :ref:`authCheck
+:parameter:`auditAuthorizationSuccess` enables auditing of 
+authorization success for the :ref:`authCheck
 <audit-action-details-results>` action. The parameter value must be
 ``true`` to audit read and write operations. However, when
 :parameter:`auditAuthorizationSuccess` is ``false`` auditing has less
-performance impact because the :doc:`audit system </core/auditing>` only
-logs authorization failures.
+performance impact because the audit system only logs authorization 
+failures.
 
 Configuration updates are distributed via the :term:`oplog` mechanism
 which means updates on :binary:`~bin.mongod` nodes are distributed to
@@ -88,8 +88,8 @@ have to :parameter:`poll <auditConfigPollingFrequencySecs>` the primary
 server at regular intervals for configuration updates. You may see
 stale data due to polling delay if you run :dbcommand:`setAuditConfig`
 on the primary server and :dbcommand:`getAuditConfig` on a
-:doc:`shard </sharding>` before the shard has polled the primary server
-for updated configuration details.
+:ref:`shard <sharding-introduction>` before the shard has polled the 
+primary server for updated configuration details.
 
 Examples
 --------
@@ -211,6 +211,7 @@ Search the ``inventory`` collection in the ``sales`` database using the
 
 .. seealso::
 
-   :method:`db.adminCommand`, :dbcommand:`getAuditConfig`,
-   :doc:`configure audit filters</tutorial/configure-audit-filters>`
+   - :method:`db.adminCommand`
+   - :dbcommand:`getAuditConfig`
+   - :ref:`configure audit filters <audit-filter>`
 
diff --git a/source/reference/configuration-options.txt b/source/reference/configuration-options.txt
@@ -4509,7 +4509,7 @@ LDAP Parameters
 
    *Type*: string
    
-   When set, :setting:`auditLog.destination` enables :doc:`auditing </core/auditing>` and
+   When set, :setting:`auditLog.destination` enables :ref:`auditing <auditing>` and
    specifies where :binary:`~bin.mongos` or :binary:`~bin.mongod` sends all audit events.
 
    :setting:`auditLog.destination` can have one of the following values:
@@ -4612,7 +4612,7 @@ LDAP Parameters
 
    *Type*: string
    
-   The output file for :doc:`auditing </core/auditing>` if
+   The output file for :ref:`auditing <auditing>` if
    :setting:`~auditLog.destination` has value of ``file``. The :setting:`auditLog.path`
    option can take either a full path name or a relative path name.
 
diff --git a/source/reference/method/Session.abortTransaction.txt b/source/reference/method/Session.abortTransaction.txt
@@ -47,7 +47,7 @@ transaction ends.
 Security
 ~~~~~~~~
 
-If running with :doc:`auditing </core/auditing>`, operations in an
+If running with :ref:`auditing <auditing>`, operations in an
 aborted transaction are still audited.
 
 Retryable
diff --git a/source/reference/method/db.rotateCertificates.txt b/source/reference/method/db.rotateCertificates.txt
@@ -145,7 +145,7 @@ Logging
 On successful rotation, the subject names, thumbprints, and the
 validity period of the server and cluster certificate thumbprints are
 logged to the configured :ref:`log destination
-<log-message-destinations>`. If :doc:`auditing </core/auditing>` is
+<log-message-destinations>`. If :ref:`auditing <auditing>` is
 enabled, this information is also written to the audit log.
 
 On Linux and Windows platforms, if a :setting:`CRL file
diff --git a/source/reference/parameters.txt b/source/reference/parameters.txt
@@ -4662,12 +4662,12 @@ Auditing Parameters
 
    |both|
 
-   Enables the :doc:`auditing </core/auditing>` of authorization
+   Enables the :ref:`auditing <auditing>` of authorization
    successes for the :ref:`authCheck <audit-action-details-results>`
    action.
 
    When :parameter:`auditAuthorizationSuccess` is ``false``, the
-   :doc:`audit system </core/auditing>` only logs the authorization
+   :ref:`audit system <auditing>` only logs the authorization
    failures for ``authCheck``.
 
    To enable the audit of authorization successes, issue the following
@@ -4722,7 +4722,7 @@ Auditing Parameters
    log encryption <security-encryption-at-rest-audit-log>`. A header is
    placed at the top of each audit log file and contains metadata for
    decrypting the audit log. The headers are also stored in the
-   :doc:`audit log </core/auditing>`.
+   :ref:`audit log <auditing>`.
 
    You can only set :parameter:`auditEncryptionHeaderMetadataFile`
    during startup in the :setting:`configuration file <setParameter>` or
diff --git a/source/reference/program/mongod.txt b/source/reference/program/mongod.txt
@@ -2920,7 +2920,7 @@ Audit Options
 .. option:: --auditDestination
 
    
-   Enables :doc:`auditing </core/auditing>` and specifies where
+   Enables :ref:`auditing <auditing>` and specifies where
    :program:`mongod` sends all audit events.
 
    :option:`--auditDestination` can have one of the following values:
@@ -2998,9 +2998,10 @@ Audit Options
 
 .. option:: --auditPath
 
-   Specifies the output file for :doc:`auditing </core/auditing>` if
-   :option:`--auditDestination` has value of ``file``. The :option:`--auditPath`
-   option can take either a full path name or a relative path name.
+   Specifies the output file for auditing if 
+   :option:`--auditDestination` has value of ``file``. The 
+   :option:`--auditPath` option can take either a full path name or a 
+   relative path name.
    
    .. include:: /includes/note-audit-in-enterprise-only.rst
 
diff --git a/source/reference/program/mongos.txt b/source/reference/program/mongos.txt
@@ -1525,7 +1525,7 @@ Audit Options
 .. option:: --auditDestination
 
    
-   Enables :doc:`auditing </core/auditing>` and specifies where
+   Enables :ref:`auditing <auditing>` and specifies where
    :program:`mongos` sends all audit events.
 
    :option:`--auditDestination` can have one of the following values:
@@ -1603,9 +1603,10 @@ Audit Options
    
 .. option:: --auditPath
 
-   Specifies the output file for :doc:`auditing </core/auditing>` if
-   :option:`--auditDestination` has value of ``file``. The :option:`--auditPath`
-   option can take either a full path name or a relative path name.
+   Specifies the output file for auditing if
+   :option:`--auditDestination` has value of ``file``. The 
+   :option:`--auditPath` option can take either a full path name or a 
+   relative path name.
    
    .. include:: /includes/note-audit-in-enterprise-only.rst
 
diff --git a/source/release-notes/2.6.txt b/source/release-notes/2.6.txt
@@ -607,7 +607,7 @@ MongoDB Enterprise for Windows includes OpenSSL version 1.0.1g.
 Auditing
 ~~~~~~~~
 
-MongoDB Enterprise adds :doc:`auditing </core/auditing>` capability for
+MongoDB Enterprise adds :ref:`auditing <auditing>` capability for
 :binary:`~bin.mongod` and :binary:`~bin.mongos` instances. See :ref:`auditing`
 for details.
 
diff --git a/source/release-notes/5.0.txt b/source/release-notes/5.0.txt
@@ -1122,7 +1122,7 @@ Log Changes to Database Profiler Settings
 Independent Log Rotation for Server and Audit Logs
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Starting in MongoDB 5.0, when :doc:`auditing </core/auditing>` is
+Starting in MongoDB 5.0, when :ref:`auditing <auditing>` is
 enabled, you may now rotate the server and audit logs
 independently using the :dbcommand:`logRotate` command.
 Previously, :dbcommand:`logRotate` would rotate the two logs together.
