Skip to content

Commit 5e56de6

Browse files
DOCSP-27358 pt3 Leafy Green updates (#486)
* DOCSP-27356 final screenshot updates * DOCSP-27356 delete picture * DOCSP-27356 update size * DOCSP-27358 size fix * DOCSP-27358 external feedback
1 parent 6ed1f02 commit 5e56de6

17 files changed

+34
-119
lines changed
41.7 KB
Loading
-172 KB
Loading
-165 KB
Loading
-89.5 KB
Loading
29.5 KB
Loading
Loading
-86.3 KB
Loading

source/in-use-encryption-tutorial.txt

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -94,10 +94,6 @@ Import Your Data
9494
The collection has a :guilabel:`Queryable Encryption` badge next to
9595
its name to indicate that fields in that collection are encrypted.
9696

97-
.. figure:: /images/compass/qe-badge.png
98-
:figwidth: 450 px
99-
:alt: Queryable Encryption Badge
100-
10197
.. step:: Click :guilabel:`Add Data`.
10298

10399
.. step:: Click :guilabel:`Import File`.
@@ -110,7 +106,7 @@ Import Your Data
110106
encrypted field is marked by a key symbol next to the value.
111107

112108
.. figure:: /images/compass/encrypted-field.png
113-
:figwidth: 450 px
109+
:figwidth: 400 px
114110
:alt: Encrypted Field
115111

116112
Here, the ``base`` field is marked with the key symbol.
@@ -144,15 +140,11 @@ To disable In-Use Encryption:
144140
.. step:: Click on :guilabel:`In-Use Encryption` on left-hand navigation bar.
145141

146142
.. figure:: /images/compass/qe-connection-button.png
147-
:figwidth: 450 px
143+
:figwidth: 300 px
148144
:alt: In-Use Encryption Connection button
149145

150146
.. step:: Click the :guilabel:`Enable In-Use Encryption for this connection`
151147
toggle.
152148

153149
Disabling In-Use Encryption only affects how |compass-short| accesses your
154150
data.
155-
156-
.. figure:: /images/compass/enable-qe.png
157-
:figwidth: 450 px
158-
:alt: Disable In-Use Encryption
Lines changed: 4 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,14 @@
11
.. procedure::
22
:style: normal
33

4-
.. step:: Open query history
4+
.. step:: Open query history.
55

6-
Click the :guilabel:`History` button at the top of the pipeline
7-
builder.
6+
Click the :guilabel:`History` button on the query bar.
87

9-
.. figure:: /images/compass/query-history-view.png
10-
:figwidth: 720 px
11-
:alt: Click history button
12-
13-
.. step:: Select favorites
8+
.. step:: Select :guilabel:`Favorites`.
149

1510
Click the :guilabel:`Star` button.
1611

17-
.. figure:: /images/compass/query-add-favorite.png
18-
:figwidth: 316 px
19-
:alt: Click star button
20-
21-
.. step:: Name your query
22-
23-
Enter a name for your query.
24-
25-
.. figure:: /images/compass/query-add-favorite-name.png
26-
:figwidth: 316 px
27-
:alt: Save favorite query
12+
.. step:: Name your query.
2813

2914
..step:: Click :guilabel:`Save`.

source/includes/fact-save-pipeline.rst

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,10 @@ To save your pipeline:
88
.. procedure::
99
:style: normal
1010

11-
.. step:: Click the save dropdown button
11+
.. step:: Click the :guilabel:`Save` dropdown button.
1212

13-
Click the :guilabel:`Save` dropdown button at the top of the pipeline
14-
builder. Click on ``Save pipeline as...``
13+
Click on ``Save pipeline as...``.
1514

16-
.. figure:: /images/compass/query-save-pipeline-as.png
17-
:alt: Save pipeline as
15+
.. step:: Enter a name for your pipeline.
1816

19-
.. step:: Enter a name for your pipeline
20-
21-
.. figure:: /images/compass/query-save-pipeline-as-name.png
22-
:alt: Name your pipeline
23-
24-
.. step:: Click :guilabel:`Save`
17+
.. step:: Click :guilabel:`Save`.
Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,15 @@
11
.. procedure::
22
:style: normal
33

4-
.. step:: Open query history
4+
.. step:: Open your query history.
55

66
Click the :guilabel:`History` button at the top of the
77
:guilabel:`Documents` tab.
88

99
.. figure:: /images/compass/query-history-view.png
10-
:figwidth: 720 px
10+
:figwidth: 600 px
1111
:alt: Query history view
1212

13-
.. step:: Select favorites
13+
.. step:: Click the :guilabel:`Favorites` button in the past queries pane.
1414

15-
Click the :guilabel:`Favorites` button in the past queries pane.
16-
17-
.. figure:: /images/compass/query-history-favorite.png
18-
:figwidth: 316px
19-
:alt: Favorites
15+
Select favorite queries.

source/includes/steps-create-query-via-builder.yaml

Lines changed: 7 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4,50 +4,28 @@ ref: click-chart-value
44
content: |
55
66
In the :guilabel:`Schema` view, you can click on a chart value to
7-
build a query. For example, the following image shows the query
8-
filter built by clicking the ``EWR`` value for the
9-
``departureAirportFsCode`` field.
10-
11-
.. figure:: /images/compass/query-builder.png
12-
:figwidth: 815px
13-
:alt: Example of a created filter
7+
build a query.
148
---
15-
title: Optional. Select multiple values.
9+
title: (Optional) Select multiple values.
1610
level: 4
1711
ref: click-chart-value-multiple
1812
content: |
1913
To select multiple values for a field, click and drag the cursor
2014
over a selection of values, or press shift+click on the desired
2115
values.
22-
23-
.. figure:: /images/compass/query-builder3.png
24-
:figwidth: 817px
25-
:alt: Exmaple of selecting multimple values for a field
26-
2716
---
28-
title: Optional. Click on other field values to create a compound query.
17+
title: (Optional) Click on other field values to create a compound query.
2918
level: 4
30-
ref: create-compound-query
31-
content: |
32-
For example, the following image shows shows the compound query
33-
built by selecting a value in the ``flightId`` field.
34-
35-
.. figure:: /images/compass/query-builder2.png
36-
:figwidth: 817px
37-
:alt: Example of a compound query
19+
ref: create-compound-query.
3820
---
39-
title: Optional. Deselect a value.
21+
title: (Optional) Deselect a value.
4022
level: 4
4123
ref: remove-from-query
4224
content: |
4325
To deselect a previously selected value, shift+click on
44-
the selected value:
45-
46-
.. figure:: /images/compass/query-builder4.png
47-
:figwidth: 740px
48-
:alt: Example of removing a value from a filter
26+
the selected value.
4927
---
50-
title: Run the query
28+
title: Run the query.
5129
level: 4
5230
ref: run-query
5331
content: |

source/includes/steps-export-pipeline-to-language.yaml

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,9 @@ content: |
1515
|compass|, see :ref:`Aggregation Pipeline Builder
1616
<compass-agg-builder>`.
1717
---
18-
title: Click the :guilabel:`Export` button.
18+
title: Click :guilabel:`Export to Language`.
1919
level: 4
2020
ref: select-export
21-
content: |
22-
.. figure:: /images/compass/agg-builder-export-dropdown.png
23-
:figwidth: 720px
24-
:alt: Aggregation Builder export dropdown
2521
---
2622
title: Select your desired export language.
2723
level: 4

source/query/queries.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ When you click a saved or favorite pipeline tile, Compass opens the
5252
:guilabel:`Aggregations` tab with the pipeline loaded.
5353

5454
.. figure:: /images/compass/query-my-queries-splash.png
55-
:figwidth: 720 px
55+
:figwidth: 650 px
5656
:alt: My queries view
5757

5858
Using the :guilabel:`Favorites` Tab

source/schema.txt

Lines changed: 9 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -201,9 +201,7 @@ Fields that contain a sub-document or an array are displayed with
201201
a small triangle next to them and a visual representation of the
202202
data contained within the sub-document or array.
203203

204-
.. figure:: /images/compass/embedded-document-sample.png
205-
:figwidth: 662px
206-
:alt: Example of fields with embedded documents or arrays
204+
|
207205

208206
Click on the triangle to expand the field and view the embedded
209207
documents:
@@ -219,10 +217,6 @@ Fields that contain GeoJSON data or ``[longitude,latitude]`` arrays are
219217
displayed with interactive maps. For more information on interacting
220218
with location data in |compass-short|, see :ref:`analyze-location-data`.
221219

222-
.. figure:: /images/compass/geo-visualization.png
223-
:figwidth: 816px
224-
:alt: Example of GeoJSON data types
225-
226220
.. include:: /includes/fact-isolated-ver-third-party-mapping.rst
227221

228222
View Charts of Mixed Types
@@ -277,10 +271,6 @@ and analyze location data. If your field contains
277271
a map containing the points from the field. The data type
278272
for location fields is ``coordinates``.
279273

280-
.. figure:: /images/compass/location-data-example.png
281-
:figwidth: 575px
282-
:alt: Image showing example field with location data
283-
284274
Apply a Location Filter
285275
~~~~~~~~~~~~~~~~~~~~~~~
286276

@@ -296,10 +286,6 @@ range of points. To define a location filter:
296286
#. Repeat this process as desired to include additional areas of
297287
the map in the schema analysis.
298288

299-
.. figure:: /images/compass/location-data-filter.png
300-
:figwidth: 575px
301-
:alt: Image showing map with filter circles drawn
302-
303289
The query bar updates as you draw location filters to show
304290
the exact coordinates used in the
305291
:manual:`$geoWithin </reference/operator/query/geoWithin/>` query
@@ -313,18 +299,11 @@ Edit a Location Filter
313299
~~~~~~~~~~~~~~~~~~~~~~
314300

315301
To move or resize a location filter, click :icon-fa5:`edit` on the
316-
right side of the map. You will enter the filter editing mode, which
317-
looks like this:
318-
319-
.. figure:: /images/compass/location-data-filter-edit.png
320-
:figwidth: 575px
321-
:alt: Image showing map filter editing
302+
right side of the map.
322303

323-
To move a filter
324-
Click and drag the square in the center of the circle.
304+
- To move a filter, click and drag the square in the center of the circle.
325305

326-
To resize a filter
327-
Click and drag the square at the edge of the circle.
306+
- To resize a filter click and drag the square at the edge of the circle.
328307

329308
After modifying your filters, click :guilabel:`Save`.
330309

@@ -359,16 +338,15 @@ To increase the value of :guilabel:`MAX TIME MS`:
359338

360339
1. In the query bar, expand :guilabel:`Options`.
361340

362-
.. figure:: /images/compass/max-time-ms.png
363-
:alt: The Options button is on the right side of the query bar,
364-
next to the Analyze button.
365-
366341
2. Increase the value of :guilabel:`MAX TIME MS` to accommodate your collection.
342+
367343
:guilabel:`MAX TIME MS` defaults to 60000 milliseconds, or 60 seconds, but large
368344
collections might take tens of seconds to analyze.
369345

370-
Once you have increased the value of :guilabel:`MAX TIME MS`, retry your schema
371-
analysis by clicking :guilabel:`Analyze`.
346+
3. Click :guilabel:`Analyze` to retry your schema.
347+
348+
Once you have increased the value of :guilabel:`MAX TIME MS` you are able to
349+
retry your schema.
372350

373351
.. toctree::
374352
:titlesonly:

source/schema/export.txt

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,7 @@ Once your schema has been analyzed, export your schema:
3030

3131
#. From the dropdown, click :guilabel:`Share Schema as JSON`.
3232

33-
.. figure:: /images/compass/share-schema-json.png
34-
:alt: Image showing Collection dropdown
35-
36-
Your schema is copied to your clipboard as a |json| object.
33+
Your schema is copied to your clipboard as a |json| object.
3734

3835
Schema Object Properties
3936
------------------------

source/validation.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ collection follow a defined set of rules, such as conforming to a
2626
specific shape or only allowing a specified range of values in fields.
2727

2828
.. figure:: /images/compass/validation-view.png
29-
:figwidth: 720px
29+
:figwidth: 600px
3030
:alt: Validation view
3131

3232
.. _update-validation:

0 commit comments

Comments
 (0)