DOCSP-45781 Clarify references to 'maxCapacityGB' in OM docs (#582)

amalhotra-mdb · web-flow · commit 815633c32251 · 2024-12-19T11:21:49.000-05:00
Clarifies references to the ``maxCapacityGB`` field throughout the Ops Manager docs. NOTE: this ticket also include references to ``maxCapacityGB`` that need to be updated in the mongocli repo. These changes will be made by the CLI team, created ticket for mongocli docs changes [here](https://jira.mongodb.org/browse/CLOUDP-289412). - [DOCSP-45781](https://jira.mongodb.org/browse/DOCSP-45781) - [STAGING - Blockstore](https://deploy-preview-582--10gen-docs-ops-manager.netlify.app/tutorial/manage-blockstore-storage/) - [STAGING - Create One Blockstore Config](https://deploy-preview-582--10gen-docs-ops-manager.netlify.app/reference/api/admin/backup/snapshot/mongoConfigs/create-one-blockstore-configuration/) - [STAGING - Update One Blockstore Config](https://deploy-preview-582--10gen-docs-ops-manager.netlify.app/reference/api/admin/backup/snapshot/mongoConfigs/update-one-blockstore-configuration/#update-one-blockstore-configuration) - [STAGING - Get All Blockstore Config](https://deploy-preview-582--10gen-docs-ops-manager.netlify.app/reference/api/admin/backup/snapshot/mongoConfigs/get-all-blockstore-configurations/#get-all-blockstore-configurations) - [STAGING - Get One Blockstore Config By ID](https://deploy-preview-582--10gen-docs-ops-manager.netlify.app/reference/api/admin/backup/snapshot/mongoConfigs/get-one-blockstore-configuration-by-id) - [STAGING - Create One Sync Store Config](https://deploy-preview-582--10gen-docs-ops-manager.netlify.app/reference/api/admin/backup/sync/mongoConfigs/create-one-sync-store-configuration/) - [STAGING - Update One Sync Store Config](https://deploy-preview-582--10gen-docs-ops-manager.netlify.app/reference/api/admin/backup/sync/mongoConfigs/update-one-sync-store-configuration/) - [STAGING - Get All Sync Store Config](https://deploy-preview-582--10gen-docs-ops-manager.netlify.app/reference/api/admin/backup/sync/mongoConfigs/get-all-sync-store-configurations/#results-embedded-document) - [STAGING - Get One Sync Store Config By ID](https://deploy-preview-582--10gen-docs-ops-manager.netlify.app/reference/api/admin/backup/sync/mongoConfigs/get-one-sync-store-configuration-by-id/#response) - [STAGING - Create One Oplog Config](https://deploy-preview-582--10gen-docs-ops-manager.netlify.app/reference/api/admin/backup/oplog/mongoConfigs/create-one-oplog-configuration/#create-one-oplog-configuration) - [STAGING - Update One Oplog Config](https://deploy-preview-582--10gen-docs-ops-manager.netlify.app/reference/api/admin/backup/oplog/mongoConfigs/update-one-oplog-configuration) - [STAGING - Get All Oplog Config](https://deploy-preview-582--10gen-docs-ops-manager.netlify.app/reference/api/admin/backup/oplog/mongoConfigs/get-all-oplog-configurations) - [STAGING - Get One Oplog Config By ID](https://deploy-preview-582--10gen-docs-ops-manager.netlify.app/reference/api/admin/backup/oplog/mongoConfigs/get-one-oplog-configuration-by-id) - [LATEST BUILD LOG](https://app.netlify.com/sites/10gen-docs-ops-manager/deploys/67619f8c25e9c20008531dda) ### Self-Review Checklist - [ ] [Define](https://wiki.corp.mongodb.com/display/DE/Taxonomy+tagging+instructions) taxonomy [values](https://wiki.corp.mongodb.com/display/DE/Docs+Taxonomy) at top of page. - [ ] Add genre facets (tutorial or reference), as in this [example PR](10gen/cloud-docs#5042). - [ ] Add programmingLanguage (if necessary). - [ ] Add meta keywords (if necessary). - [ ] Resolve any new warnings or errors in the build. - [ ] Proofread for spelling and grammatical errors. - [ ] Check staging for rendering issues. - [ ] Confirm links are working.
diff --git a/source/core/system-alerts.txt b/source/core/system-alerts.txt
@@ -182,6 +182,8 @@ Backup Daemon
      - .. alert:: Backup Daemon has sufficient free head space
      - 
 
+.. _blockstore:
+
 Blockstore
 ~~~~~~~~~~
 
diff --git a/source/includes/api/list-tables/admin-blockstore-create-request-documents.rst b/source/includes/api/list-tables/admin-blockstore-create-request-documents.rst
@@ -1,3 +1,6 @@
+.. |product| replace:: blockstore
+.. |field| replace:: ``maxCapacityGB`` 
+
 .. list-table::
    :widths: 15 15 70
    :header-rows: 1
@@ -44,8 +47,7 @@
    
    * - maxCapacityGB
      - number
-     - *Optional.* The maximum amount of data in GB this 
-       :opsmgr:`blockstore </reference/glossary/#std-term-backup-blockstore-database>` can store.
+     - .. include:: /includes/api/maxCapacityGB-description.rst
    
    * - uri
      - string
diff --git a/source/includes/api/list-tables/admin-blockstore-request-documents.rst b/source/includes/api/list-tables/admin-blockstore-request-documents.rst
@@ -1,3 +1,6 @@
+.. |product| replace:: blockstore
+.. |field| replace:: ``maxCapacityGB``
+
 .. list-table::
    :widths: 15 15 70
    :header-rows: 1
@@ -40,8 +43,8 @@
    
    * - maxCapacityGB
      - number
-     - *Optional.* The maximum amount of data in GB this 
-       :opsmgr:`blockstore </reference/glossary/#std-term-backup-blockstore-database>` can store.
+     - .. include:: /includes/api/maxCapacityGB-description.rst
+   
    
    * - uri
      - string
diff --git a/source/includes/api/list-tables/admin-blockstore-response-documents.rst b/source/includes/api/list-tables/admin-blockstore-response-documents.rst
@@ -1,3 +1,6 @@
+.. |product| replace:: blockstore
+.. |field| replace:: ``maxCapacityGB``
+
 .. list-table::
    :widths: 15 15 70
    :header-rows: 1
@@ -43,8 +46,7 @@
    
    * - maxCapacityGB
      - number
-     - The maximum amount of data in GB this :opsmgr:`blockstore </reference/glossary/#std-term-backup-blockstore-database>` can 
-       store.
+     - .. include:: /includes/api/maxCapacityGB-description.rst
    
    * - uri
      - string
diff --git a/source/includes/api/list-tables/admin-oplog-store-create-request-documents.rst b/source/includes/api/list-tables/admin-oplog-store-create-request-documents.rst
@@ -1,3 +1,6 @@
+.. |product| replace:: oplog store
+.. |field| replace:: ``maxCapacityGB``
+
 .. list-table::
    :widths: 15 15 70
    :header-rows: 1
@@ -35,8 +38,7 @@
    
    * - maxCapacityGB
      - number
-     - *Optional.* The maximum amount of data in GB this 
-       :opsmgr:`oplog store  </reference/glossary/#std-term-Oplog-Store-Database>` can store.
+     - .. include:: /includes/api/maxCapacityGB-description.rst
    
    * - uri
      - string
diff --git a/source/includes/api/list-tables/admin-oplog-store-request-documents.rst b/source/includes/api/list-tables/admin-oplog-store-request-documents.rst
@@ -1,3 +1,6 @@
+.. |product| replace:: oplog store
+.. |field| replace:: ``maxCapacityGB``
+
 .. list-table::
    :widths: 15 15 70
    :header-rows: 1
@@ -31,8 +34,7 @@
    
    * - maxCapacityGB
      - number
-     - *Optional.* The maximum amount of data in GB this 
-       :opsmgr:`oplog store  </reference/glossary/#std-term-Oplog-Store-Database>` can store.
+     - .. include:: /includes/api/maxCapacityGB-description.rst
    
    * - uri
      - string
diff --git a/source/includes/api/list-tables/admin-oplog-store-response-documents.rst b/source/includes/api/list-tables/admin-oplog-store-response-documents.rst
@@ -1,3 +1,6 @@
+.. |product| replace:: oplog store
+.. |field| replace:: ``maxCapacityGB``
+
 .. list-table::
    :widths: 15 15 70
    :header-rows: 1
@@ -34,8 +37,7 @@
  
    * - maxCapacityGB
      - number
-     - The maximum amount of data in GB this :opsmgr:`oplog store  </reference/glossary/#std-term-Oplog-Store-Database>` can 
-       store.
+     - .. include:: /includes/api/maxCapacityGB-description.rst
    
    * - uri
      - string
diff --git a/source/includes/api/list-tables/admin-sync-store-create-request-documents.rst b/source/includes/api/list-tables/admin-sync-store-create-request-documents.rst
@@ -1,3 +1,6 @@
+.. |product| replace:: sync store
+.. |field| replace:: ``maxCapacityGB``
+
 .. list-table::
    :widths: 15 15 70
    :header-rows: 1
@@ -35,8 +38,7 @@
 
    * - maxCapacityGB
      - number
-     - *Optional.* The maximum amount of data in GB this sync store can 
-       store.
+     - .. include:: /includes/api/maxCapacityGB-description.rst
    
    * - uri
      - string
diff --git a/source/includes/api/list-tables/admin-sync-store-request-documents.rst b/source/includes/api/list-tables/admin-sync-store-request-documents.rst
@@ -1,3 +1,6 @@
+.. |product| replace:: sync store
+.. |field| replace:: ``maxCapacityGB``
+
 .. list-table::
    :widths: 15 15 70
    :header-rows: 1
@@ -31,8 +34,7 @@
 
    * - maxCapacityGB
      - number
-     - *Optional.* The maximum amount of data in GB this sync store can 
-       store.
+     - .. include:: /includes/api/maxCapacityGB-description.rst
    
    * - uri
      - string
diff --git a/source/includes/api/list-tables/admin-sync-store-response-documents.rst b/source/includes/api/list-tables/admin-sync-store-response-documents.rst
@@ -1,3 +1,6 @@
+.. |product| replace:: sync store
+.. |field| replace:: ``maxCapacityGB``
+
 .. list-table::
    :widths: 15 15 70
    :header-rows: 1
@@ -34,8 +37,7 @@
    
    * - maxCapacityGB
      - number
-     - The maximum amount of data in GB this sync store can 
-       store.
+     - .. include:: /includes/api/maxCapacityGB-description.rst
    
    * - uri
      - string
diff --git a/source/includes/api/maxCapacityGB-description.rst b/source/includes/api/maxCapacityGB-description.rst
@@ -0,0 +1,3 @@
+*Optional.* The |product|’s expected maximum available capacity for use in
+the :ref:`OUTSIDE_SPACE_USED_THRESHOLD <blockstore>` alert. |field| does 
+not enforce any limitation on the size of the backing database.
diff --git a/source/includes/steps-admin-edit-blockstore.yaml b/source/includes/steps-admin-edit-blockstore.yaml
@@ -15,6 +15,9 @@ title: "Update any values that need to be changed."
 ref: edit-blockstore
 content: |
 
+  .. |product| replace:: blockstore
+  .. |field| replace:: Blockstore Max Capacity
+
   In the :guilabel:`MongoDB Connection` column, update any values that
   need to be changed in the following fields:
 
@@ -93,7 +96,7 @@ content: |
 
      * - Blockstore Max Capacity (GB)
 
-       - Type a maximum size for a blockstore.
+       - .. include:: /includes/api/maxCapacityGB-description.rst
 
      * - Load Factor
 

Original file line number	Diff line number	Diff line change
`@@ -182,6 +182,8 @@ Backup Daemon`
`182`	`182`	`- .. alert:: Backup Daemon has sufficient free head space`
`183`	`183`	`-`
`184`	`184`
	`185`	`+.. _blockstore:`
	`186`	`+`
`185`	`187`	`Blockstore`
`186`	`188`	`~~~~~~~~~~`
`187`	`189`