Skip to content

Add missing meta descriptions #211

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.

Sign up for GitHub

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 1 commit into from
Apr 11, 2025
Merged

Add missing meta descriptions #211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/api-documentation.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
API Documentation
=================

.. meta::
:description: Explore the API documentation for Kotlin, including BSON serialization, driver extensions, core functionality, and coroutine and sync drivers.

Check failure on line 6 in source/api-documentation.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules 

[vale] reported by reviewdog 🐶
[MongoDB.CommaOxford] Use the Oxford comma in ' Explore the API documentation for Kotlin, including BSON serialization, driver extensions, core functionality, and coroutine and '.

Raw Output:
{"message": "[MongoDB.CommaOxford] Use the Oxford comma in ' Explore the API documentation for Kotlin, including BSON serialization, driver extensions, core functionality, and coroutine and '.", "location": {"path": "source/api-documentation.txt", "range": {"start": {"line": 6, "column": 17}}}, "severity": "ERROR"}

.. toctree::
:titlesonly:
:maxdepth: 1
Expand Down
3 changes: 3 additions & 0 deletions source/compatibility.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Compatibility
=============

.. meta::
:description: Check the recommended versions of the MongoDB Kotlin Driver for compatibility with specific MongoDB and Kotlin versions.

.. contents:: On this page
:local:
:backlinks: none
Expand Down
3 changes: 3 additions & 0 deletions source/connection-troubleshooting.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Connection Troubleshooting
==========================

.. meta::
:description: Troubleshoot connection issues with the MongoDB Kotlin Driver by checking connection strings, configuring firewalls, and verifying authentication settings.

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

.. meta::
:keywords: troubleshooting, question, support
:description: Find answers to common questions about the Kotlin driver, including connection issues, differences from KMongo, and connection pooling.

.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/aggregation-expression-operations.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Aggregation Expression Operations
=================================

.. meta::
:description: Learn to use the MongoDB Kotlin Driver for constructing aggregation expressions with typesafe Java methods, enhancing readability and functionality.

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

.. meta::
:description: Learn to use aggregation operations in the MongoDB Kotlin driver to process data and return computed results using the aggregation pipeline.

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

.. meta::
:description: Learn how to authenticate with MongoDB using various mechanisms like SCRAM-SHA-256, MONGODB-AWS, and X.509, and configure connections with Kotlin.

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

.. meta::
:description: Explore how to use Kotlin driver builder classes for efficient CRUD operations and aggregation, enhancing error detection and code completion in your IDE.

.. toctree::

Aggregation </fundamentals/builders/aggregates>
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/collations.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
Collations
==========

.. meta::
:description: Learn how to use collations in MongoDB to order query results by string values, including specifying collations for collections, indexes, and operations.

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

.. meta::
:description: Explore how to set up and configure a connection to a MongoDB deployment using the Kotlin Coroutine driver, including options for network compression and TLS/SSL.

.. toctree::

Connect to MongoDB </fundamentals/connection/connect>
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/crud.txt
View file
Open in desktop
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 Kotlin Coroutine with MongoDB, including creating, reading, updating, and deleting documents.

.. toctree::
:caption: CRUD Operations

Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/data-formats.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
Data Formats
============

.. meta::
:description: Explore various data formats in Kotlin, including BSON, Extended JSON, and Kotlin Serialization, and learn about codecs and document data formats.

Check failure on line 6 in source/fundamentals/data-formats.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules 

[vale] reported by reviewdog 🐶
[MongoDB.CommaOxford] Use the Oxford comma in ' Explore various data formats in Kotlin, including BSON, Extended JSON, and Kotlin Serialization, and learn about codecs and '.

Raw Output:
{"message": "[MongoDB.CommaOxford] Use the Oxford comma in ' Explore various data formats in Kotlin, including BSON, Extended JSON, and Kotlin Serialization, and learn about codecs and '.", "location": {"path": "source/fundamentals/data-formats.txt", "range": {"start": {"line": 6, "column": 17}}}, "severity": "ERROR"}

.. toctree::
:caption: Data Formats

Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/databases-collections.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
Databases and Collections
=========================

.. meta::
:description: Learn to use MongoDB databases and collections with the Kotlin driver, including accessing, creating, and managing collections and specifying read/write concerns.

Check failure on line 6 in source/fundamentals/databases-collections.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules 

[vale] reported by reviewdog 🐶
[MongoDB.CommaOxford] Use the Oxford comma in ' Learn to use MongoDB databases and collections with the Kotlin driver, including accessing, creating, and managing collections and '.

Raw Output:
{"message": "[MongoDB.CommaOxford] Use the Oxford comma in ' Learn to use MongoDB databases and collections with the Kotlin driver, including accessing, creating, and managing collections and '.", "location": {"path": "source/fundamentals/databases-collections.txt", "range": {"start": {"line": 6, "column": 17}}}, "severity": "ERROR"}

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

.. meta::
:keywords: code example, optimization, atlas search
:description: Learn to create and manage indexes using the MongoDB Kotlin Driver to optimize query performance and support various query types.

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

.. meta::
:description: Learn how to set up and configure logging in the MongoDB Kotlin driver using SLF4J, including setting log levels and logger names.

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

.. meta::
:description: Learn how to set up and configure monitoring in the MongoDB Kotlin driver to track resource usage and performance.

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

.. meta::
:description: Learn how to enable and configure the Stable API feature in MongoDB to ensure compatibility with specified API versions when connecting to a server.

.. contents:: On this page
:local:
:backlinks: none
Expand Down
3 changes: 3 additions & 0 deletions source/fundamentals/time-series.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
Time Series Collections
=======================

.. meta::
:description: Learn how to create and query time series collections using the MongoDB Kotlin driver, including setting up collection options and using window functions for data aggregation.

.. contents:: On this page
:local:
:backlinks: none
Expand Down
3 changes: 3 additions & 0 deletions source/index.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB Kotlin Driver
=====================

.. meta::
:description: Explore the MongoDB Kotlin Driver for server-side applications using coroutines, including setup, usage examples, and troubleshooting.

.. toctree::
:titlesonly:
:maxdepth: 1
Expand Down
1 change: 1 addition & 0 deletions source/issues-and-help.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

.. meta::
:keywords: kotlin coroutine, troubleshooting, feedback
:description: Find support for the Kotlin driver through the MongoDB Community Forums, report issues via Jira, or contribute improvements with pull requests.

Check failure on line 13 in source/issues-and-help.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules 

[vale] reported by reviewdog 🐶
[MongoDB.AvoidObscure] Use 'through, by' instead of 'via'.

Raw Output:
{"message": "[MongoDB.AvoidObscure] Use 'through, by' instead of 'via'.", "location": {"path": "source/issues-and-help.txt", "range": {"start": {"line": 13, "column": 105}}}, "severity": "ERROR"}

.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/quick-reference.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Quick Reference
===============

.. meta::
:description: Explore Kotlin Coroutine driver syntax for MongoDB commands, including find, insert, update, delete, and more, with examples and API documentation links.

Check failure on line 8 in source/quick-reference.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules 

[vale] reported by reviewdog 🐶
[MongoDB.CommaOxford] Use the Oxford comma in ' Explore Kotlin Coroutine driver syntax for MongoDB commands, including find, insert, update, delete, and more, with examples and '.

Raw Output:
{"message": "[MongoDB.CommaOxford] Use the Oxford comma in ' Explore Kotlin Coroutine driver syntax for MongoDB commands, including find, insert, update, delete, and more, with examples and '.", "location": {"path": "source/quick-reference.txt", "range": {"start": {"line": 8, "column": 17}}}, "severity": "ERROR"}

This page shows the driver syntax for several MongoDB commands and links to
their related reference and API documentation.

Expand Down
1 change: 1 addition & 0 deletions source/quick-start.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Kotlin Driver Quick Start

.. meta::
:keywords: code example, get started, runnable app
:description: Learn to connect a Kotlin application to a MongoDB Atlas cluster using the Kotlin driver, including setup, dependencies, and querying sample data.

.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/usage-examples.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
Usage Examples
==============

.. meta::
:description: Explore Kotlin usage examples for popular MongoDB operations, including setup instructions and sample code for easy integration.

.. contents:: On this page
:local:
:backlinks: none
Expand Down
3 changes: 3 additions & 0 deletions source/whats-new.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
What's New
==========

.. meta::
:description: Discover the latest features, improvements, and fixes in recent Kotlin driver versions, including new classes, API changes, and enhanced support for various MongoDB functionalities.

.. contents:: On this page
:local:
:backlinks: none
Expand Down
Loading