DOCSP-45624 updated maxCapacityGB param description (#651)

kyuan-mongodb · web-flow · commit 8a9a85885eba · 2025-01-13T11:18:32.000-05:00
diff --git a/source/core/system-alerts.txt b/source/core/system-alerts.txt
@@ -178,6 +178,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,9 +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
      - A comma-separated list of hosts in the ``<hostname:port>``
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
`@@ -178,6 +178,8 @@ Backup Daemon`
`178`	`178`	`- .. alert:: Backup Daemon has sufficient free head space`
`179`	`179`	`-`
`180`	`180`
	`181`	`+.. _blockstore:`
	`182`	`+`
`181`	`183`	`Blockstore`
`182`	`184`	`~~~~~~~~~~`
`183`	`185`