Docs 16078 support out with time series (#4795) (#4943)

* Docs 16078 support out with time series (#4795)

* Draft

* Externalized time series config field descriptions

* Removed self references

* Added missing field

* Removed self refs

* Added entry to out vs merge comparison table

* Removed time series collection limitation from restrictions

* caps

* Fixed time series reference table syntax for expireAfterSeconds

* Internal PR feedback

* External PR feedback

* External PR feedback

* Internal review feedback

* Used enum values for time series granularity syntax

* Rebuild

Author: nvillahermosa-mdb

source/core/timeseries/timeseries-limitations.txt

@@ -36,12 +36,11 @@ The following features are not supported for time series collections:
 collections are asymmetrically synchronized. For details, see
 :realm:`Enable Atlas Device Sync </sync/configure/enable-sync>`.
 
-Aggregation $out and $merge
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Aggregation $merge
+~~~~~~~~~~~~~~~~~~
 
-You cannot use the :pipeline:`$out` or :pipeline:`$merge` aggregation
-pipeline stages to add data from another collection to a time series
-collection.
+You cannot use the :pipeline:`$merge` aggregation stage to add data from
+another collection to a time series collection.
 
 .. _timeseries-limitations-updates-deletes:
 

source/core/timeseries/timeseries-procedures.txt

@@ -129,41 +129,17 @@ A time series collection includes the following fields:
 
   * - ``timeseries.granularity``
     - integer
-    - Optional. Do not use if setting ``bucketRoundingSeconds`` and 
-      ``bucketMaxSpanSeconds``. 
-      
-      Possible values are ``seconds`` (default), ``minutes``, and ``hours``.
-     
-      Set ``granularity`` to the value that most closely matches 
-      the time between consecutive incoming timestamps. This
-      improves performance by optimizing how MongoDB stores data in the collection.
-
-      For more information on granularity and bucket intervals, see 
-      :ref:`timeseries-granularity`.
+    - .. include:: /includes/time-series/fact-granularity-field-description.rst
 
   * - ``timeseries.bucketMaxSpanSeconds``
     - integer
-    - Optional. Use with ``bucketRoundingSeconds`` as an alternative
-      to ``granularity``. Sets the maximum time between timestamps
-      in the same bucket. 
-      
-      Possible values are 1-31536000.
-
-      .. versionadded:: 6.3
-
+    - .. include:: /includes/time-series/fact-bucketmaxspanseconds-field-description.rst
 
   * - ``timeseries.bucketRoundingSeconds``
     - integer
-    - Optional. Use with ``bucketMaxSpanSeconds`` as an alternative
-      to ``granularity``. Must be equal to ``bucketMaxSpanSeconds``.
-
-      When a document requires a new bucket, MongoDB rounds down the
-      document's timestamp value by this interval to set the minimum
-      time for the bucket.
-       
-      .. versionadded:: 6.3
+    - .. include:: /includes/time-series/fact-bucketroundingseconds-field-description.rst
 
-  * - ``expireAfterSeconds``
+  * - ``timeseries.expireAfterSeconds``
     - integer
     - Optional. Enable the automatic deletion of documents in a
       time series collection by specifying the number of seconds

source/includes/time-series/fact-bucketmaxspanseconds-field-description.rst

@@ -0,0 +1,7 @@
+Optional. Use with ``bucketRoundingSeconds`` as an alternative
+to ``granularity``. Sets the maximum time between timestamps
+in the same bucket. 
+
+Possible values are 1-31536000.
+
+.. versionadded:: 6.3

source/includes/time-series/fact-bucketroundingseconds-field-description.rst

@@ -0,0 +1,8 @@
+Optional. Use with ``bucketMaxSpanSeconds`` as an alternative
+to ``granularity``. Must be equal to ``bucketMaxSpanSeconds``.
+
+When a document requires a new bucket, MongoDB rounds down the
+document's timestamp value by this interval to set the minimum
+time for the bucket.
+   
+.. versionadded:: 6.3

source/includes/time-series/fact-granularity-field-description.rst

@@ -0,0 +1,12 @@
+Optional. Do not use if setting ``bucketRoundingSeconds`` and 
+``bucketMaxSpanSeconds``. 
+
+Possible values are ``seconds`` (default), ``minutes``, and ``hours``.
+
+Set ``granularity`` to the value that most closely matches 
+the time between consecutive incoming timestamps. This
+improves performance by optimizing how MongoDB stores data in the 
+collection.
+
+For more information on granularity and bucket intervals, see 
+:ref:`timeseries-granularity`.