Skip to content

Commit a674b81

Browse files
DOCSP-28027 document Time series option UI changes (#602)
* DOCSP-28027 document Time series option UI changes * DOCSP-28027 updates for JM's feedback
1 parent 673d0de commit a674b81

7 files changed

+46
-50
lines changed

source/collections/capped-collection.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,28 +16,28 @@ Create a Capped Collection
1616
collections that support high-throughput operations that insert and retrieve
1717
documents based on insertion order.
1818

19-
Procedure
20-
---------
19+
Steps
20+
-----
2121

2222
.. procedure::
2323
:style: connected
2424

25-
.. step:: Click the :guilabel:`Create Collection` button.
25+
.. step:: Click the :guilabel:`Create Collection` button
2626

2727
From the :guilabel:`Collections` screen, click the
2828
:guilabel:`Create Collection` button.
2929

30-
.. step:: Enter the collection name.
30+
.. step:: Enter the collection name
3131

32-
.. step:: Click the :guilabel:`Advanced Collection Options` dropdown.
32+
.. step:: Click the :guilabel:`Additional preferences` dropdown
3333

3434
Check the :guilabel:`Capped Collection` option.
3535

36-
.. step:: Enter the :guilabel:`size` of the capped collection.
36+
.. step:: Enter the :guilabel:`size` of the capped collection
3737

3838
Enter the maximum number of bytes that the collection can hold.
3939

40-
.. step:: Click :guilabel:`Create Collection` to create the collection.
40+
.. step:: Click :guilabel:`Create Collection` to create the collection
4141

4242
Restrictions and Limitations
4343
----------------------------

source/collections/clustered-collection.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Steps
4848

4949
.. step:: Select the type of collection you want to create.
5050

51-
From the :guilabel:`Advanced Collection Options` drop-down, select
51+
From the :guilabel:`Additional preferences` drop-down, select
5252
:guilabel:`Clustered Collections`.
5353

5454
.. step:: (Optional) Name your clustered index.

source/collections/collation-collection.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Procedure
2929

3030
.. step:: Enter the collection name.
3131

32-
.. step:: Click the :guilabel:`Advanced Collection Options` dropdown.
32+
.. step:: Click the :guilabel:`Additional preferences` dropdown.
3333

3434
Check the :guilabel:`Use Custom Collaton` option.
3535

source/collections/encrypted-collection.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Procedure
2828

2929
.. step:: Enter the collection name.
3030

31-
.. step:: Click the :guilabel:`Advanced Collection Options` dropdown.
31+
.. step:: Click the :guilabel:`Additional preferences` dropdown.
3232

3333
Check the :guilabel:`Queryable Encryption` option.
3434

source/collections/time-series-collection.txt

Lines changed: 34 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -28,71 +28,67 @@ Procedure
2828

2929
.. step:: Enter the collection name.
3030

31-
.. step:: Click the :guilabel:`Advanced Collection Options` dropdown.
32-
33-
Check the :guilabel:`Time Series Collection` option.
31+
.. step:: Check the :guilabel:`Time Series Collection` option.
3432

3533
.. step:: Specify a :guilabel:`timeField`.
3634

3735
Specify which field should be used as the ``timeField`` for the time-series
3836
collection. This field must have a :manual:`BSON type date </reference/bson-types/>`.
3937

40-
The following fields are optional:
38+
.. step:: *Optional*. Specify a :guilabel:`metaField`.
4139

42-
.. list-table::
43-
:header-rows: 1
44-
:widths: 20 20 60
40+
Specify the name of the field that contains metadata in each time
41+
series document. The metadata in the specified field should be
42+
data that is used to label a unique series of documents.
4543

46-
* - Field
47-
- Type
48-
- Description
44+
.. step:: *Optional*. Select a :guilabel:`granularity` from the dropdown.
4945

50-
* - ``metaField``
51-
- string
52-
- The name of the field that contains metadata in each time series
53-
document. The metadata in the specified field should be data that
54-
is used to label a unique series of documents.
46+
Specify a coarser granularity so measurements over a longer time
47+
span can be more efficiently stored and queried. The default value
48+
is ``"seconds"``.
5549

56-
* - ``granularity``
57-
- string
58-
- Specifies a coarser granularity so measurements over a
59-
longer time span can be more efficiently stored and queried.
50+
If you set the ``granularity`` parameter, you can't set the
51+
``bucketMaxSpanSeconds`` and ``bucketRoundingSeconds`` parameters.
6052

61-
The default value is ``"seconds"``.
53+
.. step:: *Optional*. Specify a numeric value for the following fields.
6254

63-
If you set the ``granularity`` parameter, you can't set the
64-
``bucketMaxSpanSeconds`` and ``bucketRoundingSeconds`` parameters.
55+
.. list-table::
56+
:widths: 20 10 70
57+
:header-rows: 1
6558

66-
* - ``expireAfterSeconds``
67-
- number
68-
- Enables the automatic deletion of documents that are older than
69-
the specified number of seconds.
59+
* - Field
60+
- Type
61+
- Description
7062

7163
* - ``bucketMaxSpanSeconds``
7264
- number
73-
- Specifies the maximum time span between measurements in a bucket.
65+
- Specifies the maximum time span between measurements in a bucket.
7466

75-
The value of ``bucketMaxSpanSeconds`` must be the same as
76-
``bucketRoundingSeconds``. If you set the ``bucketMaxSpanSeconds``,
77-
parameter, you can't set the ``granularity`` parameter.
67+
The value of ``bucketMaxSpanSeconds`` must be the same as
68+
``bucketRoundingSeconds``. If you set the ``bucketMaxSpanSeconds``,
69+
parameter, you can't set the ``granularity`` parameter.
7870

7971
* - ``bucketRoundingSeconds``
8072
- number
81-
- Specifies the time interval that determines the starting timestamp
82-
for a new bucket.
73+
- Specifies the time interval that determines the starting timestamp
74+
for a new bucket.
8375

84-
The value of ``bucketRoundingSeconds`` must be the same as
85-
``bucketMaxSpanSeconds``. If you set the ``bucketRoundingSeconds``,
86-
parameter, you can't set the ``granularity`` parameter.
76+
The value of ``bucketRoundingSeconds`` must be the same as
77+
``bucketMaxSpanSeconds``. If you set the ``bucketRoundingSeconds``,
78+
parameter, you can't set the ``granularity`` parameter.
8779

88-
For more information on time series fields, see
89-
:manual:`Time Series Object Fields
90-
</core/timeseries/timeseries-procedures/#timeseries-object-fields>`.
80+
* - ``expireAfterSeconds``
81+
- number
82+
- Enables the automatic deletion of documents that are older than
83+
the specified number of seconds.
9184

9285
.. step:: Click :guilabel:`Create Collection` to create the collection.
9386

9487
Your collection will be marked by a :guilabel:`time series` badge.
9588

89+
For more information on time series fields, see :manual:`Time Series
90+
Object Fields </core/timeseries/timeseries-procedures/#timeseries-object-fields>`.
91+
9692
Restrictions and Limitations
9793
----------------------------
9894

source/in-use-encryption-tutorial.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Procedure
6262

6363
Enter the name of the database and/or collection.
6464

65-
.. step:: Click the :guilabel:`Advanced Collection Options` drop down.
65+
.. step:: Click the :guilabel:`Additional preferences` drop down.
6666

6767
.. step:: Check the :guilabel:`{+qe+}` box.
6868

source/includes/steps-create-collection.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ content: |
1212
In the :guilabel:`Create Collection` dialog, enter the name of the
1313
collection to create.
1414
15-
|compass-short| also provides you with :guilabel:`Advanced Collection Options`.
15+
|compass-short| also provides you with :guilabel:`Additional preferences`.
1616
You can select from the following:
1717
1818
- :ref:`Create a Capped Collection <capped-collection>`

0 commit comments

Comments
 (0)