Skip to content

Commit 119be2e

Browse files
authored
DOCSP-31521: V2 cleanup (#85)
1 parent d49ce16 commit 119be2e

32 files changed

+270
-126
lines changed

source/fundamentals/aggregation.txt

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
Aggregation
55
===========
66

7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: pipeline, code example
13+
714
.. contents:: On this page
815
:local:
916
:backlinks: none
@@ -254,7 +261,7 @@ Retrieve Data guide.
254261
API Documentation
255262
~~~~~~~~~~~~~~~~~
256263

257-
To learn more about any of the methods or types discussed in this
264+
To learn more about the methods and types mentioned in this
258265
guide, see the following API documentation:
259266

260267
- `aggregate() <{+api+}/struct.Collection.html#method.aggregate>`__

source/fundamentals/authentication.txt

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
Authentication Mechanisms
55
=========================
66

7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: validate credentials, protocols, code example
13+
714
.. contents:: On this page
815
:local:
916
:backlinks: none
@@ -315,7 +322,7 @@ To learn more about managing users of your MongoDB deployment, see
315322
API Documentation
316323
~~~~~~~~~~~~~~~~~
317324

318-
To learn more about the methods and types discussed in this
325+
To learn more about the methods and types mentioned in this
319326
guide, see the following API documentation:
320327

321328
- `Credential <{+api+}/options/struct.Credential.html>`__

source/fundamentals/connections/connection-guide.txt

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
Connection Guide
55
================
66

7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: access deployment, code example, authentication
13+
714
.. contents:: On this page
815
:local:
916
:backlinks: none
@@ -133,8 +140,10 @@ verify that the connection is successful. Select from the
133140
:guilabel:`Asynchronous API` or :guilabel:`Synchronous API` tabs below for corresponding
134141
connection code samples.
135142

136-
.. TODO To learn more about asynchronous and synchronous runtimes, see the
137-
.. :ref:`Runtimes <link>` guide.
143+
.. tip::
144+
145+
To learn more about asynchronous and synchronous runtimes, see the
146+
:ref:`rust-runtimes` guide.
138147

139148
.. tabs::
140149

source/fundamentals/crud/compound-operations.txt

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
Compound Operations
55
===================
66

7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: write lock, code example
13+
714
.. contents:: On this page
815
:local:
916
:backlinks: none
@@ -135,7 +142,8 @@ The following table describes the options available in
135142
| Type: ``WriteConcern``
136143

137144
* - ``collation``
138-
- | The collation to use when sorting results.
145+
- | The collation to use when sorting results. To learn more about collations,
146+
see the :ref:`rust-collations` guide.
139147
|
140148
| Type: ``Collation``
141149
| Default: ``None``
@@ -301,7 +309,8 @@ The following table describes the options available in
301309
| Type: ``WriteConcern``
302310

303311
* - ``collation``
304-
- | The collation to use when sorting results.
312+
- | The collation to use when sorting results. To learn more about collations,
313+
see the :ref:`rust-collations` guide.
305314
|
306315
| Type: ``Collation``
307316
| Default: ``None``
@@ -337,7 +346,7 @@ The following table describes the options available in
337346
The {+driver-short+} implements the Builder design pattern for the
338347
creation of a ``FindOneAndUpdateOptions`` instance. You can use the
339348
type's ``builder()`` method to construct an options instance by
340-
chaining option builder functions one at a time.
349+
chaining option builder methods one at a time.
341350

342351
The following code shows how to construct a ``FindOneAndUpdateOptions``
343352
instance and pass it to the ``find_one_and_update()`` method:
@@ -469,7 +478,8 @@ The following table describes the options available in
469478
| Type: ``WriteConcern``
470479

471480
* - ``collation``
472-
- | The collation to use when sorting results.
481+
- | The collation to use when sorting results. To learn more about collations,
482+
see the :ref:`rust-collations` guide.
473483
|
474484
| Type: ``Collation``
475485
| Default: ``None``
@@ -564,7 +574,7 @@ following documentation:
564574
API Documentation
565575
~~~~~~~~~~~~~~~~~
566576

567-
To learn more about the methods and types discussed in this
577+
To learn more about the methods and types mentioned in this
568578
guide, see the following API documentation:
569579

570580
- `find_one_and_delete() <{+api+}/struct.Collection.html#method.find_one_and_delete>`__

source/fundamentals/crud/read-operations/query.txt

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
Specify a Query
55
===============
66

7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: search, compare, code example
13+
714
.. contents:: On this page
815
:local:
916
:backlinks: none
@@ -394,7 +401,7 @@ To learn more about query operators, see :manual:`Query Selectors
394401
API Documentation
395402
~~~~~~~~~~~~~~~~~
396403

397-
To learn more about any of the methods or types used in this
404+
To learn more about the methods and types used in this
398405
guide, see the following API documentation:
399406

400407
- `find() <{+api+}/struct.Collection.html#method.find>`__

source/fundamentals/crud/read-operations/retrieve.txt

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
Retrieve Data
55
=============
66

7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: find one, find many, pipeline, code example
13+
714
.. contents:: On this page
815
:local:
916
:backlinks: none
@@ -124,7 +131,8 @@ The following table describes commonly used settings that you can specify in
124131
- Description
125132

126133
* - ``collation``
127-
- | The collation to use when sorting results.
134+
- | The collation to use when sorting results. To learn more about collations,
135+
see the :ref:`rust-collations` guide.
128136
|
129137
| Type: ``Collation``
130138
| Default: ``None``
@@ -168,7 +176,6 @@ The following table describes commonly used settings that you can specify in
168176
| Default: ``None``
169177

170178
.. TODO link to projection fundamentals page under projection setting
171-
.. TODO link to collation fundamentals page under collations setting
172179
.. TODO link to skip fundamentals page under skip setting
173180
.. TODO link to sort fundamentals page under sort setting
174181

@@ -325,7 +332,8 @@ The following table describes commonly used settings that you can specify in
325332
subsequent batches
326333

327334
* - ``collation``
328-
- | The collation to use when sorting results.
335+
- | The collation to use when sorting results. To learn more about collations,
336+
see the :ref:`rust-collations` guide.
329337
|
330338
| Type: ``Collation``
331339
| Default: ``None``
@@ -356,8 +364,6 @@ The following table describes commonly used settings that you can specify in
356364
|
357365
| Type: ``WriteConcern``
358366

359-
.. TODO link to collation fundamentals page under collations setting
360-
361367
For a full list of settings, see the API
362368
documentation for `AggregateOptions <{+api+}/options/struct.AggregateOptions.html>`__.
363369

@@ -393,11 +399,11 @@ pipeline that contains the following stages:
393399
Additional Information
394400
----------------------
395401

396-
.. TODO For runnable examples of the find operations, see the following usage
397-
.. examples:
398-
..
399-
.. - :ref:`rust-find-one`
400-
.. - :ref:`rust-find-multiple`
402+
For runnable examples of the find operations, see the following usage
403+
examples:
404+
405+
- :ref:`rust-find-one-usage`
406+
- :ref:`rust-find-usage`
401407

402408
To learn more about the operations in this guide, see the
403409
following documentation:
@@ -415,7 +421,7 @@ following documentation:
415421
API Documentation
416422
~~~~~~~~~~~~~~~~~
417423

418-
To learn more about the methods and types discussed in this
424+
To learn more about the methods and types mentioned in this
419425
guide, see the following API documentation:
420426

421427
- `find_one() <{+api+}/struct.Collection.html#method.find_one>`__

source/fundamentals/crud/write-operations/change.txt

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
Modify Documents
55
================
66

7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: update one, update many, set options, code example
13+
714
.. contents:: On this page
815
:local:
916
:backlinks: none
@@ -437,7 +444,8 @@ The following table describes the options available in ``UpdateOptions``:
437444
| Type: ``bool``
438445

439446
* - ``collation``
440-
- | The collation to use when sorting results.
447+
- | The collation to use when sorting results. To learn more about collations,
448+
see the :ref:`rust-collations` guide.
441449
|
442450
| Type: ``Collation``
443451
| Default: ``None``
@@ -497,12 +505,12 @@ documentation:
497505
- :ref:`rust-query-guide` guide
498506
- :ref:`rust-compound-operations` guide
499507

500-
.. TODO For runnable examples of the update and replace operations, see the
501-
.. following usage examples:
502-
..
503-
.. - :ref:`rust-update-one`
504-
.. - :ref:`rust-update-many`
505-
.. - :ref:`rust-replace`
508+
For runnable examples of the update and replace operations, see the
509+
following usage examples:
510+
511+
- :ref:`rust-update-one-usage`
512+
- :ref:`rust-update-many-usage`
513+
- :ref:`rust-replace-usage`
506514

507515
To learn more about the update operators, see :manual:`Update Operators
508516
</reference/operator/update/#update-operators>` in the Server manual.
@@ -514,7 +522,7 @@ To learn more about the update operators, see :manual:`Update Operators
514522
API Documentation
515523
~~~~~~~~~~~~~~~~~
516524

517-
To learn more about any of the methods or types discussed in this
525+
To learn more about the methods and types mentioned in this
518526
guide, see the following API documentation:
519527

520528
- `update_one() <{+api+}/struct.Collection.html#method.update_one>`__

source/fundamentals/crud/write-operations/delete.txt

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
Delete Documents
55
================
66

7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: set options, code example
13+
714
.. contents:: On this page
815
:local:
916
:backlinks: none
@@ -82,7 +89,8 @@ The following table describes settings that you can specify in a
8289
- Description
8390

8491
* - ``collation``
85-
- | The collation to use when sorting results.
92+
- | The collation to use when sorting results. To learn more about collations,
93+
see the :ref:`rust-collations` guide.
8694
|
8795
| Type: ``Collation``
8896
| Default: ``None``
@@ -178,24 +186,24 @@ following parameters:
178186
Additional Information
179187
----------------------
180188

181-
.. TODO For runnable examples of the delete operations, see the following usage
182-
.. examples:
189+
For runnable examples of the delete operations, see the following usage
190+
examples:
183191

184-
.. - :ref:`rust-delete-one`
185-
.. - :ref:`rust-delete-many`
192+
- :ref:`rust-delete-one-usage`
193+
- :ref:`rust-delete-many-usage`
186194

187195
To learn more about the operations in this guide, see the
188196
following documentation:
189197

190198
- :ref:`rust-query-guide` guide
199+
- :ref:`rust-collations` guide
191200

192201
.. - :ref:`rust-indexes`.
193-
.. - :ref:`rust-collations`.
194202

195203
API Documentation
196204
~~~~~~~~~~~~~~~~~
197205

198-
To learn more about any of the methods or types discussed in this
206+
To learn more about the methods and types mentioned in this
199207
guide, see the following API documentation:
200208

201209
- `delete_one() <{+api+}/struct.Collection.html#method.delete_one>`__

source/fundamentals/crud/write-operations/insert.txt

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
Insert Documents
55
================
66

7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: set options, bulk write error, code example
13+
714
.. contents:: On this page
815
:local:
916
:backlinks: none
@@ -318,13 +325,16 @@ still find the non-error-producing documents in your collection:
318325
Additional Information
319326
----------------------
320327

321-
.. TODO For runnable examples of the insert operations, see the following usage
322-
.. examples:
328+
For runnable examples of the insert operations, see the following usage
329+
examples:
330+
331+
- :ref:`rust-insert-one-usage`
332+
- :ref:`rust-insert-many-usage`
323333

324334
API Documentation
325335
~~~~~~~~~~~~~~~~~
326336

327-
To learn more about any of the methods or types discussed in this
337+
To learn more about the methods and types mentioned in this
328338
guide, see the following API documentation:
329339

330340
- `insert_one() <{+api+}/struct.Collection.html#method.insert_one>`__

source/fundamentals/enterprise-auth.txt

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
Enterprise Authentication Mechanisms
55
====================================
66

7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: enterprise edition, verify credentials, code example
13+
714
.. contents:: On this page
815
:local:
916
:backlinks: none
@@ -115,7 +122,7 @@ To learn more about the concepts in this guide, see the following documentation:
115122
API Documentation
116123
~~~~~~~~~~~~~~~~~
117124

118-
To learn more about the methods and types discussed in this
125+
To learn more about the methods and types mentioned in this
119126
guide, see the following API documentation:
120127

121128
- `Credential <{+api+}/options/struct.Credential.html>`__

0 commit comments

Comments
 (0)