Skip to content

Add missing meta descriptions #488

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions source/compatibility.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Compatibility
=============

.. meta::
:description: Check the recommended MongoDB Go Driver versions for compatibility with different MongoDB server versions.

.. contents:: On this page
:local:
:backlinks: none
Expand Down
1 change: 1 addition & 0 deletions source/connection-troubleshooting.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Connection Troubleshooting

.. meta::
:keywords: code example, disconnected, deployment
:description: Troubleshoot connection issues with the MongoDB Go Driver by verifying connection strings, authentication mechanisms, and firewall settings.

.. contents:: On this page
:local:
Expand Down
1 change: 1 addition & 0 deletions source/faq.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ FAQ

.. meta::
:keywords: code example, connection error, question, help
:description: Find answers to common questions about the MongoDB Go Driver, including connection pooling, error handling, and BSON to JSON conversion.

.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
Fundamentals
============

.. meta::
:description: Explore tasks like connecting to MongoDB, performing transactions, and working with BSON using the MongoDB Go Driver.

.. toctree::
:titlesonly:
:maxdepth: 1
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/aggregation.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Aggregation
===========

.. meta::
:description: Explore how to use aggregation operations in the MongoDB Go Driver, including examples of grouping, sorting, and filtering data in collections.

.. contents:: On this page
:local:
:backlinks: none
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/auth.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Authentication Mechanisms
=========================

.. meta::
:description: Learn how to use various authentication mechanisms with the MongoDB Go Driver, including SCRAM, MONGODB-AWS, and X.509.

.. contents:: On this page
:local:
:backlinks: none
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/bson.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Work with BSON

.. meta::
:keywords: code examples, serialization
:description: Learn how the MongoDB Go Driver handles BSON data conversion, including marshalling and unmarshalling, and how to use struct tags and BSON options.

Overview
--------
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/collations.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Collations
==========

.. meta::
:description: Learn how to use collations in MongoDB to order query results by string values according to specific language and locale conventions.

.. contents:: On this page
:local:
:backlinks: none
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/connections.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Connections
===========

.. meta::
:description: Explore how to configure connections to a MongoDB deployment using the MongoDB Go Driver, including options for TLS and network compression.

.. toctree::

Connection Guide </fundamentals/connections/connection-guide>
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/connections/network-compression.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Network Compression
===================

.. meta::
:description: Learn how to enable network compression in the MongoDB Go Driver for MongoDB using Snappy, Zlib, or Zstandard algorithms to reduce data transfer.

.. contents:: On this page
:local:
:backlinks: none
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/connections/tls.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Enable and Configure TLS

.. meta::
:keywords: code example, security, connection options
:description: Learn how to secure your MongoDB connection using TLS by enabling TLS options and configuring certificates in your Go application.

.. contents:: On this page
:local:
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/context.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Context

.. meta::
:keywords: code example, unblock
:description: Learn how to use the context package in Go to manage timeouts and cancellations for blocking method calls in the MongoDB Go driver.

.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/crud.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
CRUD Operations
===============

.. meta::
:description: Explore how to perform CRUD operations using the MongoDB Go Driver, including creating, reading, updating, and deleting documents.

.. toctree::
:caption: CRUD Operations

Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/crud/compound-operations.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Compound Operations
===================

.. meta::
:description: Learn how to perform compound operations in MongoDB using Go, combining read and write actions into a single atomic operation to prevent data alteration.

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/crud/read-operations/changestream.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Monitor Data Changes

.. meta::
:keywords: code example, delta
:description: Learn how to monitor document changes in MongoDB using change streams, including opening streams and modifying output with pipelines and options.

.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/crud/read-operations/count.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Count Documents
===============

.. meta::
:description: Learn to count documents in a MongoDB collection using Go, including accurate, estimated, and aggregation-based methods.

.. contents:: On this page
:local:
:backlinks: none
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/crud/read-operations/cursor.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Access Data From a Cursor

.. meta::
:keywords: code example, read operation, see results, iterate
:description: Learn to access data using a cursor in Go, including retrieving documents individually or in batches, and closing the cursor to free resources.

.. contents:: On this page
:local:
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/crud/read-operations/distinct.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Retrieve Distinct Values

.. meta::
:keywords: read operation, code example
:description: Learn how to retrieve distinct values for a specified field in a collection using the Distinct() method in Go.

.. contents:: On this page
:local:
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/crud/read-operations/limit.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Limit the Number of Returned Results

.. meta::
:keywords: read operation, code example, pipeline, customize output
:description: Learn how to limit the number of documents returned in read operations using the MongoDB Go Driver, including examples with sorting and aggregation.

.. contents:: On this page
:local:
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/crud/read-operations/project.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Specify Which Fields to Return

.. meta::
:keywords: read, code example, pipeline stage, customize output
:description: Learn how to specify which fields to return in MongoDB documents using projections in Go, including examples for including or excluding fields.

.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/crud/read-operations/query-document.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Specify a Query
===============

.. meta::
:description: Learn how to specify queries in Go to match subsets of documents using filters, operators, and various criteria.

.. contents:: On this page
:local:
:backlinks: none
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/crud/read-operations/retrieve.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Retrieve Data
==============

.. meta::
:description: Learn how to retrieve data by using MongoDB Go Driver read operations, including find and aggregation methods.

.. contents:: On this page
:local:
:backlinks: none
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/crud/read-operations/skip.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Skip Returned Results
=====================

.. meta::
:description: Learn how to skip a specified number of results in MongoDB read operations using the setSkip() method or the $skip stage in aggregation pipelines.

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/crud/read-operations/sort.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Sort Results
============

.. meta::
:description: Learn how to sort query results, handle ties, and apply sorting in aggregation pipelines with the MongoDB Go Driver.

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/crud/read-operations/text.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Search Text
===========

.. meta::
:description: Learn how to perform text searches with the MongoDB Go Driver, including creating text indexes and sorting results by relevance.

.. contents:: On this page
:local:
:backlinks: none
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/crud/write-operations/bulk.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Bulk Operations
===============

.. meta::
:description: Learn to perform bulk write operations with the MongoDB Go Driver, including inserts, updates, replacements, and deletions, using the bulkWrite() method.

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/crud/write-operations/delete.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Delete Documents
================

.. meta::
:description: Learn how to remove documents from collections with the deleteOne() and deleteMany() methods in the MongoDB Go Driver, with examples and options.

.. contents:: On this page
:local:
:backlinks: none
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/crud/write-operations/embedded-arrays.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Update Arrays in a Document
===========================

.. meta::
:description: Learn how to update array elements in documents using positional operators and the findOneAndUpdate() method in the MongoDB Go Driver.

.. contents:: On this page
:local:
:backlinks: none
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/crud/write-operations/insert.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Insert a Document

.. meta::
:keywords: code example, write operation, add data
:description: Learn how to insert documents into a MongoDB collection using the insertOne() and insertMany() methods, with options to modify their behavior.

.. contents:: On this page
:local:
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/crud/write-operations/modify.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Modify Documents

.. meta::
:keywords: code example, write operation, change data
:description: Learn how to modify MongoDB documents using update and replace operations, including methods like updateOne(), updateMany(), and replaceOne().

.. contents:: On this page
:local:
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/crud/write-operations/upsert.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Insert or Update in a Single Operation

.. meta::
:keywords: code example, write, add data
:description: Learn how to perform an upsert in MongoDB using Go, which updates existing documents or inserts new ones if no match is found.

.. contents:: On this page
:local:
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/crud/write-read-pref.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Modify Execution of CRUD Operations

.. meta::
:keywords: code example, replica set, consistency
:description: Learn how to modify CRUD operations in the MongoDB Go Driver using write concern, read concern, and read preference configurations for replica sets.

.. contents:: On this page
:local:
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/encrypt-fields.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@

.. meta::
:keywords: privacy, security
:description: Use the MongoDB Go Driver to encrypt document fields with in-use encryption, protecting sensitive data like credit card numbers and health information.

.. sharedinclude:: dbx/encrypt-fields.rst
1 change: 1 addition & 0 deletions source/fundamentals/enterprise-auth.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Enterprise Authentication Mechanisms

.. meta::
:keywords: security, code example, credentials
:description: Learn how to authenticate with the MongoDB Go Driver using Enterprise Edition mechanisms like GSSAPI/Kerberos and LDAP, with examples.

.. contents:: On this page
:local:
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/geo.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Work with Geospatial Data

.. meta::
:keywords: code example, coordinates, location, geographic
:description: Learn to work with geospatial data in the MongoDB Go Driver using GeoJSON and legacy formats, create geospatial indexes, and perform queries.

.. contents:: On this page
:local:
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/gridfs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ GridFS

.. meta::
:keywords: code example, large files, storage, images
:description: Learn how to store and retrieve large files in the MongoDB Go Driver using GridFS, which splits files into chunks and manages them in a bucket for efficient access.

.. contents:: On this page
:local:
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/indexes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Indexes

.. meta::
:keywords: code example
:description: Learn how to use indexes in the MongoDB Go Driver to improve query performance and support various operations like updates and deletes.

.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/logging.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Logging
=======

.. meta::
:description: Configure logging in your Go application using the MongoDB Go Driver to record events, set severity levels, and integrate custom or third-party loggers.

.. contents:: On this page
:local:
:backlinks: none
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/monitoring.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Monitoring
==========

.. meta::
:description: Explore monitoring techniques for cluster configuration, command execution, and connection pool changes in Go.

.. toctree::
:caption: Monitoring categories

Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/monitoring/cluster-monitoring.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Cluster Monitoring

.. meta::
:keywords: code example, server, topology
:description: Monitor topology events with the MongoDB Go Driver to track cluster changes, assess health, and perform capacity planning by subscribing to SDAM events.

.. contents:: On this page
:local:
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/monitoring/command-monitoring.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Command Monitoring

.. meta::
:keywords: code example, operation
:description: Learn to monitor MongoDB command events using the Go driver to track query performance and resolve bottlenecks.

.. contents:: On this page
:local:
Expand Down
1 change: 1 addition & 0 deletions source/fundamentals/monitoring/connection-monitoring.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Connection Monitoring

.. meta::
:keywords: code example, performance, monitor
:description: Monitor the Mongo DB Go Driver's connection pool by subscribing to connection pool events to optimize performance and understand the client lifecycle.

.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/run-command.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Run a Command
=============

.. meta::
:description: Learn how to execute database commands using the MongoDB Go Driver, including methods for running commands and handling responses.

.. contents:: On this page
:local:
:backlinks: none
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/stable-api.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
{+stable-api+}
==============

.. meta::
:description: Learn how to specify Stable API compatibility in the MongoDB Go Driver to ensure operations align with a defined API version.

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
Loading
Loading