Skip to content

Commit a87dee3

Browse files
nlarewgithub-actions[bot]
authored andcommitted
Add missing meta descriptions (#1074)
* Add missing meta descriptions * Apply suggestions from code review --------- Co-authored-by: Rachel Mackintosh <[email protected]> (cherry picked from commit 3c73d87)
1 parent fc93cf7 commit a87dee3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+166
-0
lines changed

Diff for: source/aggregation-tutorials.txt

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Aggregation Tutorials
1010

1111
.. meta::
1212
:keywords: node.js, code example, runnable app
13+
:description: Explore step-by-step aggregation tutorials for common tasks using the MongoDB Node.js Driver, including setup instructions and runnable code examples.
1314

1415
.. contents:: On this page
1516
:local:

Diff for: source/aggregation-tutorials/filtered-subset.txt

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Filtered Subset
1616

1717
.. meta::
1818
:keywords: code example, node.js, sort, limit, aggregation
19+
:description: Learn to use the MongoDB Node.js Driver to create an aggregation pipeline that filters, sorts, and formats a subset of documents in a MongoDB collection.
1920

2021
Introduction
2122
------------

Diff for: source/aggregation-tutorials/group-total.txt

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Group and Total
1616

1717
.. meta::
1818
:keywords: code example, node.js, analyze, aggregation
19+
:description: Learn to use the MongoDB Node.js Driver to construct an aggregation pipeline that groups and analyzes data.
1920

2021
Introduction
2122
------------

Diff for: source/aggregation-tutorials/multi-field-join.txt

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Multi-Field Join
1616

1717
.. meta::
1818
:keywords: code example, node.js, lookup, aggregation
19+
:description: Learn to perform a multi-field join using the MongoDB Node.js Driver to combine data from two collections in an aggregation pipeline.
1920

2021
Introduction
2122
------------

Diff for: source/aggregation-tutorials/one-to-one-join.txt

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ One-to-One Join
1616

1717
.. meta::
1818
:keywords: code example, node.js, lookup, aggregation
19+
:description: Learn to perform a one-to-one join using the MongoDB Node.js Driver to combine data from two collections in an aggregation pipeline.
1920

2021
Introduction
2122
------------

Diff for: source/aggregation-tutorials/unpack-arrays.txt

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Unpack Arrays and Group
1616

1717
.. meta::
1818
:keywords: code example, node.js, analyze, array
19+
:description: Learn to use the MongoDB Node.js Driver to create an aggregation pipeline that unpacks arrays, filters, groups, and computes fields in MongoDB.
1920

2021
Introduction
2122
------------

Diff for: source/connection-troubleshooting.txt

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Connection Troubleshooting
1010

1111
.. meta::
1212
:keywords: code example, node.js, disconnected, help
13+
:description: Troubleshoot connection issues with the MongoDB Node.js Driver by checking connection strings, configuring firewalls, and adjusting settings like `maxPoolSize` and `connectTimeoutMS`.
1314

1415
.. contents:: On this page
1516
:local:

Diff for: source/faq.txt

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
FAQ
55
===
66

7+
.. meta::
8+
:description: Find answers to frequently asked questions about the MongoDB Node.js Driver, including connection pooling, timeouts, and handling network behavior.
9+
710
.. contents:: On this page
811
:local:
912
:backlinks: none

Diff for: source/fundamentals.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
Fundamentals
33
============
44

5+
.. meta::
6+
:description: Explore tasks using the MongoDB Node.js Driver, including connecting, authenticating, reading, writing, and managing transactions in MongoDB.
7+
58
.. default-domain:: mongodb
69

710
.. toctree::

Diff for: source/fundamentals/aggregation.txt

+3
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
Aggregation
66
===========
77

8+
.. meta::
9+
:description: Learn to use aggregation operations in the MongoDB Node.js Driver to create pipelines for data transformation and summarization.
10+
811
.. contents:: On this page
912
:local:
1013
:backlinks: none

Diff for: source/fundamentals/authentication.txt

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Authentication
55
==============
66

7+
.. meta::
8+
:description: Authenticate using the MongoDB Node.js Driver with various supported authentication mechanisms.
9+
710
.. default-domain:: mongodb
811

912
.. toctree::

Diff for: source/fundamentals/authentication/enterprise-mechanisms.txt

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Enterprise Authentication Mechanisms
1616

1717
.. meta::
1818
:keywords: ldap, encryption, principal, tls
19+
:description: Explore sample code for connecting to MongoDB using enterprise authentication mechanisms like Kerberos, LDAP, and MONGODB-OIDC with the MongoDB Node.js Driver.
1920

2021
In this guide, you can find sample code for connection to MongoDB with each
2122
authentication mechanism available in the MongoDB Enterprise Edition:

Diff for: source/fundamentals/authentication/mechanisms.txt

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Authentication Mechanisms
55
=========================
66

7+
.. meta::
8+
:description: Explore sample code for connecting to MongoDB using various authentication mechanisms with the MongoDB Node.js Driver, including `SCRAM-SHA-256`, `SCRAM-SHA-1`, `MONGODB-CR`, `MONGODB-AWS`, and `X.509`.
9+
710
.. contents:: On this page
811
:local:
912
:backlinks: none

Diff for: source/fundamentals/bson.txt

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
BSON Settings
55
=============
66

7+
.. meta::
8+
:description: Configure BSON serialization settings in your application with the MongoDB Node.js Driver, including handling undefined values and UTF-8 validation.
9+
710
.. toctree::
811
:caption: BSON settings
912

Diff for: source/fundamentals/bson/undefined-values.txt

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Undefined Values
55
================
66

7+
.. meta::
8+
:description: Learn to control the serialization of undefined values in MongoDB Node.js Driver by using the ignoreUndefined setting at various levels.
9+
710
.. contents:: On this page
811
:local:
912
:backlinks: none

Diff for: source/fundamentals/bson/utf8-validation.txt

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
UTF-8 Validation
55
================
66

7+
.. meta::
8+
:description: Learn how to enable or disable UTF-8 validation in the MongoDB Node.js Driver to manage data encoding and processing overhead.
9+
710
.. contents:: On this page
811
:local:
912
:backlinks: none

Diff for: source/fundamentals/collations.txt

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Collations
55
==========
66

7+
.. meta::
8+
:description: Learn how to use collations to apply specific sorting rules for string operations based on language and locale preferences with the MongoDB Node.js Driver.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

Diff for: source/fundamentals/connection/connection-options.txt

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Connection Options
1010

1111
.. meta::
1212
:keywords: node.js, customize
13+
:description: Explore connection and authentication options available in the MongoDB Node.js Driver, including settings for app name, authentication mechanisms, and TLS configurations.
1314

1415
This section explains the MongoDB connection and authentication options
1516
supported by the {+driver-short+} that you can set within a ``MongoClientOptions`` instance.

Diff for: source/fundamentals/connection/network-compression.txt

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Network Compression
55
===================
66

7+
.. meta::
8+
:description: Enable network compression in the MongoDB Node.js Driver to reduce data transfer using Snappy, Zlib, or Zstandard algorithms.
9+
710
You can enable a driver option to compress messages, which reduces the amount
811
of data passed over the network between MongoDB and your application.
912

Diff for: source/fundamentals/connection/socks.txt

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Enable SOCKS5 Proxy Support
55
===========================
66

7+
.. meta::
8+
:description: Learn how to connect to MongoDB using a SOCKS5 proxy by configuring the MongoDB Node.js Driver with the necessary proxy options.
9+
710
.. contents:: On this page
811
:local:
912
:backlinks: none

Diff for: source/fundamentals/connection/tls.txt

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Enable TLS on a Connection
1010

1111
.. meta::
1212
:keywords: code example, node.js, security, encrypt
13+
:description: Learn how to connect to MongoDB instances with the MongoDB Node.js Driver by using TLS by enabling the TLS option and providing necessary certificates for secure connections.
1314

1415
.. contents:: On this page
1516
:local:

Diff for: source/fundamentals/crud/compound-operations.txt

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Compound Operations
1010

1111
.. meta::
1212
:keywords: node.js, atomic operation, read, write
13+
:description: Explore how to perform compound operations with the MongoDB Node.js Driver by using methods like findOneAndDelete(), findOneAndUpdate(), and findOneAndReplace() for atomic read-write actions.
1314

1415
.. contents:: On this page
1516
:local:

Diff for: source/fundamentals/crud/query-document.txt

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Specify a Query
55
===============
66

7+
.. meta::
8+
:description: Learn how to use query documents with the MongoDB Node.js Driver by using comparison, logical, element, and evaluation operators to filter documents in a collection.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

Diff for: source/fundamentals/crud/read-operations/cursor.txt

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Access Data From a Cursor
55
=========================
66

7+
.. meta::
8+
:description: Access data from a cursor in the MongoDB Node.js Driver by using various paradigms like asynchronous iteration, manual iteration, and streaming, while managing resources with utility methods.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

Diff for: source/fundamentals/crud/read-operations/geo.txt

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Search Geospatially
55
===================
66

7+
.. meta::
8+
:description: Explore how to perform geospatial queries with the MongoDB Node.js Driver by using geospatial query operators with examples for both Earth-like sphere and 2D plane coordinate systems.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

Diff for: source/fundamentals/crud/read-operations/limit.txt

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Limit the Number of Returned Results
55
====================================
66

7+
.. meta::
8+
:description: Use the limit() method in the MongoDB Node.js Driver to cap the number of documents returned in a read operation, with examples of combining it with sort and skip options for pagination.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

Diff for: source/fundamentals/crud/read-operations/project.txt

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Specify Which Fields to Return
55
==============================
66

7+
.. meta::
8+
:description: Use projections with the MongoDB Node.js Driver to control which fields are returned in query results, optimizing network bandwidth by including or excluding specific fields.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

Diff for: source/fundamentals/crud/read-operations/skip.txt

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Skip Returned Results
55
=====================
66

7+
.. meta::
8+
:description: Use the skip option in MongoDB Node.js Driver read operations to omit a specified number of documents from the beginning of the result set, often combined with the sort option for ordered results.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

Diff for: source/fundamentals/crud/read-operations/sort.txt

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Sort Results
55
============
66

7+
.. meta::
8+
:description: Use the sort function in the MongoDB Node.js Driver to order query results by specified fields and resolve ties with other fields.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

Diff for: source/fundamentals/crud/read-operations/text.txt

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Search Text
55
===========
66

7+
.. meta::
8+
:description: Perform text searches with the MongoDB Node.js Driver using the $text operator to find documents with specified words or phrases, and sort results by relevance.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

Diff for: source/fundamentals/crud/read-write-pref.txt

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Specify How CRUD Operations Run on Replica Sets
1010

1111
.. meta::
1212
:keywords: node.js, customize, preferences, replica set, consistency
13+
:description: Learn to use the MongoDB Node.js Driver to configure write concern, read concern, and read preference for CRUD operations on replica sets to customize data consistency and availability.
1314

1415
.. contents:: On this page
1516
:local:

Diff for: source/fundamentals/crud/write-operations/delete.txt

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Delete Documents
55
================
66

7+
.. meta::
8+
:description: Learn how to use deleteOne() and deleteMany() methods in the MongoDB Node.js Driver to remove documents from a collection based on specified query criteria.
9+
710
.. contents:: On this page
811
:local:
912
:backlinks: none

Diff for: source/fundamentals/crud/write-operations/embedded-arrays.txt

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Update Arrays in a Document
55
===========================
66

7+
.. meta::
8+
:description: Learn how to use array update operators in the MongoDB Node.js Driver to modify embedded arrays in documents, including positional operators.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

Diff for: source/fundamentals/crud/write-operations/insert.txt

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Insert Documents
1010

1111
.. meta::
1212
:keywords: code example, node.js, add data
13+
:description: Learn how to insert single or multiple documents into a MongoDB collection using the MongoDB Node.js Driver, with examples of handling unique _id constraints.
1314

1415
.. contents:: On this page
1516
:local:

Diff for: source/fundamentals/crud/write-operations/modify.txt

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Modify Documents
55
================
66

7+
.. meta::
8+
:description: Modify documents in a collection using update and replace operations in the MongoDB Node.js Driver using updateOne(), updateMany(), and replaceOne() methods.
9+
710
.. contents:: On this page
811
:local:
912
:backlinks: none

Diff for: source/fundamentals/crud/write-operations/pkFactory.txt

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Generate Custom Values for ``_id``
55
==================================
66

7+
.. meta::
8+
:description: Learn how to use the MongoDB Node.js Driver to generate custom _id values with a primary key factory during insert operations.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

Diff for: source/fundamentals/crud/write-operations/upsert.txt

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Insert or Update in a Single Operation
1010

1111
.. meta::
1212
:keywords: code example, node.js, write, add data
13+
:description: Streamline your application logic by using the upsert option in the MongoDB Node.js Driver to insert or update documents in a single operation based on their existence.
1314

1415
.. contents:: On this page
1516
:local:

Diff for: source/fundamentals/encrypt-fields.txt

+1
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,6 @@
66

77
.. meta::
88
:keywords: node.js
9+
:description: Encrypt specific document fields using in-use encryption with the MongoDB Node.js Driver to protect sensitive data before sending it to MongoDB.
910

1011
.. sharedinclude:: dbx/encrypt-fields.rst

Diff for: source/fundamentals/gridfs.txt

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ GridFS
1010

1111
.. meta::
1212
:keywords: node.js, code example, file storage
13+
:description: Learn how to store and retrieve large files with the MongoDB Node.js Driver by using GridFS, including creating buckets, uploading, downloading, renaming, and deleting files.
1314

1415
.. contents:: On this page
1516
:local:

Diff for: source/fundamentals/indexes.txt

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Indexes
1010

1111
.. meta::
1212
:keywords: node.js, code example, Atlas search
13+
:description: Explore how to create and manage various types of indexes with the MongoDB Node.js Driver to optimize query performance and support efficient data retrieval.
1314

1415
.. contents:: On this page
1516
:local:

Diff for: source/fundamentals/logging.txt

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Logging
1010

1111
.. meta::
1212
:keywords: code example, log, information, monitor
13+
:description: Learn how to monitor and log MongoDB Node.js Driver events.
1314

1415
.. contents:: On this page
1516
:local:

Diff for: source/fundamentals/monitoring.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
Monitoring
33
==========
44

5+
.. meta::
6+
:description: Explore cluster, command, and connection pool monitoring in the MongoDB Node.js Driver.
7+
58
.. facet::
69
:name: genre
710
:values: reference

Diff for: source/fundamentals/monitoring/cluster-monitoring.txt

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Cluster Monitoring
1010

1111
.. meta::
1212
:keywords: code example, node.js, watch
13+
:description: Monitor topology events in a MongoDB instance, replica set, or sharded cluster by subscribing to Server Discovery and Monitoring (SDAM) events with the MongoDB Node.js Driver.
1314

1415
.. contents:: On this page
1516
:local:

Diff for: source/fundamentals/monitoring/command-monitoring.txt

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Command Monitoring
1010

1111
.. meta::
1212
:keywords: code example, node.js, watch, command status
13+
:description: Monitor the success or failure of MongoDB commands by subscribing to command monitoring events in your application with the MongoDB Node.js Driver.
1314

1415
.. contents:: On this page
1516
:local:

0 commit comments

Comments
 (0)