Ports changes from 3 CM PRs to OM v7.0 (#435)

sarahsimpers · kyuan-mongodb · web-flow · commit 3d0310974c26 · 2024-10-02T13:53:43.000-04:00
Ports changes from the following PRs to OM v7.0: - https://github.com/10gen/docs-cloud-manager/commit/eb237c28c523045426eeb85ef7977f7782a60ece - https://github.com/10gen/docs-cloud-manager/commit/0a878775af24eaf894eb42eb66c87b58dc8962d2 - https://github.com/10gen/docs-cloud-manager/commit/79ff7b0f082480411032e279d77a9f6bb5e591c7 Co-authored-by: kyuan-mongodb <78768401+kyuan-mongodb@users.noreply.github.com>
diff --git a/source/core/api.txt b/source/core/api.txt
@@ -313,11 +313,9 @@ The response entity contains three fields:
   * - ``totalCount``
     - Total number of items in the entire result set.
 
-      .. example::
-
-         If a project has a total of 57 hosts, and you make a request
-         with ``pageNum=6`` and ``itemsPerPage=10``, then
-         ``totalCount`` is **57**.
+      For example, if a project has a total of 57 hosts, and you make a request
+      with ``pageNum=6`` and ``itemsPerPage=10``, then
+      ``totalCount`` is **57**.
 
   * - ``results``
     - Result set, which is an array of entity documents.
@@ -484,22 +482,18 @@ Responses utilize the standard |http| response codes, including:
       Keep in mind that each resource may only support a subset of
       |http| methods.
 
-      .. example::
-
-         You are not allowed to ``DELETE`` the
-         :doc:`root </reference/api/root>` resource.
+      For example, you are not allowed to ``DELETE`` the
+      :doc:`root </reference/api/root>` resource.
 
   * - 409
     - Conflict
     - This is typically the response to a request to create or modify
       a property of an entity that is unique when an existing entity
       already exists with the same value for that property.
 
-      .. example::
-
-         If you attempt to
-         :doc:`create a project </reference/api/groups/create-one-group>`
-         with the same name as an existing project, the request fails.
+      For example, if you attempt to
+      :doc:`create a project </reference/api/groups/create-one-group>`
+      with the same name as an existing project, the request fails.
 
   * - 5xx
     - Various server errors
diff --git a/source/includes/api/list-tables/agent-api-keys-response-documents.rst b/source/includes/api/list-tables/agent-api-keys-response-documents.rst
@@ -15,10 +15,8 @@
      - string
      - Agent API Key.
 
-       .. note::
-
-          After creating this Agent API Key, subsequent requests 
-          return the last four characters of Agent API Keys.
+       After creating this Agent API Key, subsequent requests 
+       return the last four characters of Agent API Keys.
 
    * - desc
      - string
diff --git a/source/includes/api/list-tables/alerts/alert-response-elements.rst b/source/includes/api/list-tables/alerts/alert-response-elements.rst
@@ -68,11 +68,9 @@
      - string
      - Units for the value. Value depends on the type of metric.
 
-       .. example::
-
-          A metric that measures memory consumption would have a byte
-          measurement, while a metric that measures time would have a
-          time unit.
+       For example, a metric that measures memory consumption would have a byte
+       measurement, while a metric that measures time would have a
+       time unit.
 
        |mms| can return:
 
diff --git a/source/includes/api/list-tables/alerts/response-elements.rst b/source/includes/api/list-tables/alerts/response-elements.rst
@@ -68,11 +68,9 @@
      - string
      - Units for the value. Value depends on the type of metric.
 
-       .. example::
-
-          A metric that measures memory consumption would have a byte
-          measurement, while a metric that measures time would have a
-          time unit.
+       For example, a metric that measures memory consumption would have a byte
+       measurement, while a metric that measures time would have a
+       time unit.
 
        |mms| can return:
 
diff --git a/source/includes/api/list-tables/apiKeys-projects-response-values.rst b/source/includes/api/list-tables/apiKeys-projects-response-values.rst
@@ -21,7 +21,7 @@
      - Redacted Private key for this Organization |api| key assigned to
        this Project.
 
-       .. note:: This key displays unredacted when first created.
+       **This key displays unredacted when first created.**
 
    * - ``publicKey``
      - string
diff --git a/source/includes/api/list-tables/events/responses/orgs-cloud.rst b/source/includes/api/list-tables/events/responses/orgs-cloud.rst
@@ -56,9 +56,9 @@
      - string
      - Relevant units for the value.
 
-       .. example::
-        
-          A metric that measures memory consumption would have a byte measurement, while a metric that measures time would have a time unit.
+       For example, a metric that measures memory consumption would have
+       a byte measurement, while a metric that measures time would have
+       a time unit.
 
        Accepted values are:
 
diff --git a/source/includes/api/list-tables/events/responses/projects-cloud.rst b/source/includes/api/list-tables/events/responses/projects-cloud.rst
@@ -56,9 +56,7 @@
      - string
      - Relevant units for the value.
 
-       .. example::
-        
-          A metric that measures memory consumption would have a byte measurement, while a metric that measures time would have a time unit.
+       For example, a metric that measures memory consumption would have a byte measurement, while a metric that measures time would have a time unit.
 
        Accepted values are:
 
diff --git a/source/includes/api/list-tables/snapshot-schedule/requests-cloud.rst b/source/includes/api/list-tables/snapshot-schedule/requests-cloud.rst
@@ -30,10 +30,8 @@
      - Number of days to retain daily snapshots. You can set a value
        between ``1`` and ``365``, inclusive.
 
-       .. note::
-
-          Setting ``dailySnapshotRetentionDays`` to ``0`` disables this
-          rule.
+       Setting ``dailySnapshotRetentionDays`` to ``0`` disables this
+       rule.
 
    * - ``fullIncrementalDayOfWeek``
      - string
@@ -59,9 +57,8 @@
      - Number of months to retain monthly snapshots. You can set a
        value between ``1`` and ``36``, inclusive.
 
-       .. note::
-
-          Setting ``monthlySnapshotRetentionMonths`` to ``0`` disables this rule.
+       Setting ``monthlySnapshotRetentionMonths`` to ``0`` disables this
+       rule.
 
    * - ``snapshotIntervalHours``
      - number
@@ -81,8 +78,6 @@
      - Number of weeks to retain weekly snapshots. You can set a value
        between ``1`` and ``52``, inclusive.
 
-       .. note::
-
-          Setting ``weeklySnapshotRetentionWeeks`` to ``0`` disables
-          this rule.
+       Setting ``weeklySnapshotRetentionWeeks`` to ``0`` disables this
+       rule.
 
diff --git a/source/includes/api/list-tables/snapshot-schedule/responses-cloud.rst b/source/includes/api/list-tables/snapshot-schedule/responses-cloud.rst
@@ -26,10 +26,8 @@
      - Number of days to retain daily snapshots. |mms| may return
        values between ``1`` and ``365``, inclusive.
 
-       .. note::
-
-          Setting ``dailySnapshotRetentionDays`` to ``0`` disables this
-          rule.
+       Setting ``dailySnapshotRetentionDays`` to ``0`` disables this
+       rule.
 
    * - ``fullIncrementalDayOfWeek``
      - string
@@ -51,9 +49,8 @@
      - Number of months to retain monthly snapshots. |mms| may return
        values between ``1`` and ``36``, inclusive.
 
-       .. note::
-
-          Setting ``monthlySnapshotRetentionMonths`` to ``0`` disables this rule.
+       Setting ``monthlySnapshotRetentionMonths`` to ``0`` disables this
+       rule.
 
    * - ``pointInTimeWindowHours``
      - number
@@ -75,7 +72,5 @@
      - Number of weeks to retain weekly snapshots. |mms| may return
        values between ``1`` and ``52``, inclusive.
 
-       .. note::
-
-          Setting ``weeklySnapshotRetentionWeeks`` to ``0`` disables
-          this rule.
+       Setting ``weeklySnapshotRetentionWeeks`` to ``0`` disables this
+       rule.
diff --git a/source/includes/extracts-monitor-chart-controls.yaml b/source/includes/extracts-monitor-chart-controls.yaml
@@ -24,11 +24,9 @@ content: |
     
   To reset to the originally selected range (zoom out), double-click the chart.
 
-  .. note::
-
-     When you zoom in on a period of time, the 
-     :guilabel:`Current Display` date range in the chart control 
-     section automatically updates to reflect the selected period.
+  When you zoom in on a period of time, the 
+  :guilabel:`Current Display` date range in the chart control 
+  section automatically updates to reflect the selected period.
 
 ---
 ref: monitor-chart-controls-point
diff --git a/source/includes/extracts-monitor-view-controls.yaml b/source/includes/extracts-monitor-view-controls.yaml
@@ -21,29 +21,25 @@ content: |
   granularity available within the selected time range and sharded
   cluster metric rendering limits.
 
-  .. note:: Sharded Cluster Metric Rendering Limits
-     
-     In the Sharded Cluster metrics view, |mms| renders a maximum of:
+  In the Sharded Cluster metrics view, |mms| renders a maximum of:
       
-     - 3,000 data points for a single series, and
-     - 100,000 total data points.
+  - 3,000 data points for a single series, and
+  - 100,000 total data points.
      
-     As a result, when rendering metrics for large deployments over a
-     long period of time, |mms| may display metrics at a lower
-     granularity than is retained.
-
-     .. example::
-
-        For Premium |mms| users, |mms| retains data for the past
-        year with a granularity of 1 hour. A year's worth of data
-        results in ``365`` days * ``24`` hours, or ``8760`` data
-        points per data series. Therefore, when rendering a year
-        of historical metrics, |mms| renders the chart at a lower
-        granularity because it can only render a maximum 3,000
-        data points for a single series.
-
-     The granularity at which |mms| gathers and stores metric data
-     depends on your |mms| plan.
+  As a result, when rendering metrics for large deployments over a
+  long period of time, |mms| may display metrics at a lower
+  granularity than is retained.
+
+  For example, for Premium |mms| users, |mms| retains data for the past
+  year with a granularity of 1 hour. A year's worth of data
+  results in ``365`` days * ``24`` hours, or ``8760`` data
+  points per data series. Therefore, when rendering a year
+  of historical metrics, |mms| renders the chart at a lower
+  granularity because it can only render a maximum 3,000
+  data points for a single series.
+
+  The granularity at which |mms| gathers and stores metric data
+  depends on your |mms| plan.
 ---
 ref: monitor-view-control-zoom
 content: |
diff --git a/source/includes/org-and-project-roles.rst b/source/includes/org-and-project-roles.rst
@@ -4,9 +4,7 @@
 
 - Project Roles
 
-  .. note::
-
-     Groups and projects are synonymous terms.
+  Groups and projects are synonymous terms.
 
   - ``GROUP_OWNER``
   - ``GROUP_READ_ONLY``
diff --git a/source/includes/steps-data-explorer-pipeline-settings.yaml b/source/includes/steps-data-explorer-pipeline-settings.yaml
@@ -24,10 +24,8 @@ content: |
        - When enabled, the :guilabel:`Data Explorer` adds helper
          comments to each stage.
   
-         .. note::
-  
-            Changing this setting only affects new stages and does not
-            modify stages which have already been added to your pipeline.
+         Changing this setting only affects new stages and does not
+         modify stages which have already been added to your pipeline.
        - On
   
      * - :guilabel:`Number of Preview Documents`
diff --git a/source/reference/alerts.txt b/source/reference/alerts.txt
@@ -137,9 +137,8 @@ conditions include:
        - :term:`arbiters <arbiter>`
        - :manual:`mongos </reference/program/mongos/#mongodb-binary-bin.mongos>`
 
-       .. seealso::
+       To learn more, see :manual:`Rollbacks During Replica Set Failover </core/replica-set-rollbacks>`.
 
-          :manual:`Rollbacks During Replica Set Failover </core/replica-set-rollbacks>`
    * - Host is recovering
      - A :manual:`secondary </reference/glossary/#std-term-secondary>` enters the :replstate:`RECOVERING` state. To
        learn more about the :replstate:`RECOVERING` state, see
@@ -149,11 +148,9 @@ conditions include:
      - Revision of MongoDB running on a host is two or more
        revisions behind the current stable release of MongoDB.
 
-       .. example::
-        
-          If the current stable release is MongoDB 4.0.9, a host
-          running MongoDB 4.0.8 would not trigger an alert but a host
-          running MongoDB version 4.0.7 would trigger an alert.
+       For example, if the current stable release is MongoDB 4.0.9, a host
+       running MongoDB 4.0.8 would not trigger an alert but a host
+       running MongoDB version 4.0.7 would trigger an alert.
 
        To learn more about MongoDB version numbering, see
        :ref:`MongoDB Version Numbers <release-version-numbers>`
@@ -1038,11 +1035,9 @@ conditions include:
        usage exceeds the guaranteed baseline CPU credit accumulation
        rate.
 
-       .. note::
-
-          This alert typically triggers when all credits have been
-          consumed on an `AWS burstable performance instance
-          <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html>`__.
+       This alert typically triggers when all credits have been
+       consumed on an `AWS burstable performance instance
+       <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html>`__.
 
    * - System: Max CPU (Steal) % is
      - Maximum percentage of time that the CPU is in a state of 
@@ -1236,10 +1231,8 @@ include:
        roughly once every 10 seconds. If |mms| does not receive a ping
        for at least 1 minute, this alert triggers. 
        
-       .. note::
-       
-          This alert triggers only if the {+aagent+} is managing a
-          MongoDB process or agent module.
+       This alert triggers only if the {+aagent+} is managing a
+       MongoDB process or agent module.
 
    * - {+magent+} is down
      - No {+magent+} is detected for at least 7 minutes. Under
diff --git a/source/reference/api/alert-configurations-get-open-alerts.txt b/source/reference/api/alert-configurations-get-open-alerts.txt
@@ -123,9 +123,9 @@ Each **result** is one alert configuration.
      - string
      - Units for the value. Depends on the type of metric.
 
-       .. example::
-
-          A metric that measures memory consumption would have a byte measurement, while a metric that measures time would have a time unit. Accepted values are:
+       For example, a metric that measures memory consumption would have
+       a byte measurement, while a metric that measures time would have
+       a time unit. Accepted values are:
 
        .. include:: /includes/possibleValues-api-units.rst
 
diff --git a/source/reference/api/api-keys/project/update-one-apiKey-in-one-project.txt b/source/reference/api/api-keys/project/update-one-apiKey-in-one-project.txt
@@ -74,10 +74,8 @@ The body parameter is required.
 
        .. include:: /includes/api/lists/project-roles.rst
 
-       .. note::
-
-          Include all roles that you want this API Key to have. Any
-          roles not in this array are removed.
+       Include all roles that you want this API Key to have. Any
+       roles not in this array are removed.
 
 Response
 --------
