From 76fed8a3c4742cda536c1c4d9702047232efb1ab Mon Sep 17 00:00:00 2001 From: Nick Larew Date: Mon, 14 Apr 2025 08:43:05 -0500 Subject: [PATCH] Add missing meta descriptions (#116) * Add missing meta descriptions * Update source/testing.txt * Update source/thread-safety.txt --------- Co-authored-by: Rachel Mackintosh <148898879+rachel-mack@users.noreply.github.com> (cherry picked from commit 8390a62c20bad481f124f0137f6cd2cf8860a5b5) --- source/api-abi-versioning.txt | 3 +++ source/api-abi-versioning/abi-versioning.txt | 3 +++ source/api-abi-versioning/api-versioning.txt | 3 +++ source/index.txt | 3 +++ source/testing.txt | 3 +++ source/thread-safety.txt | 3 +++ 6 files changed, 18 insertions(+) diff --git a/source/api-abi-versioning.txt b/source/api-abi-versioning.txt index 191946f1..35bceef1 100644 --- a/source/api-abi-versioning.txt +++ b/source/api-abi-versioning.txt @@ -4,6 +4,9 @@ API and ABI Versioning ====================== +.. meta:: + :description: Understand the API and ABI versioning for the C++ driver, including header file structure, library filenames, and the use of CMake package config files. + .. contents:: On this page :local: :backlinks: none diff --git a/source/api-abi-versioning/abi-versioning.txt b/source/api-abi-versioning/abi-versioning.txt index 734eb13c..5d928383 100644 --- a/source/api-abi-versioning/abi-versioning.txt +++ b/source/api-abi-versioning/abi-versioning.txt @@ -4,6 +4,9 @@ ABI Versioning =============== +.. meta:: + :description: Understand how the C++ Driver uses ABI versioning to manage stability and compatibility for shared libraries, including the use of ABI namespaces and versioning policies. + .. contents:: On this page :local: :backlinks: none diff --git a/source/api-abi-versioning/api-versioning.txt b/source/api-abi-versioning/api-versioning.txt index 71318fc3..a1e17ed6 100644 --- a/source/api-abi-versioning/api-versioning.txt +++ b/source/api-abi-versioning/api-versioning.txt @@ -4,6 +4,9 @@ API Versioning =============== +.. meta:: + :description: Understand how the C++ Driver uses Semantic Versioning for API versioning, distinguishing between public and private APIs, and handling deprecations. + .. contents:: On this page :local: :backlinks: none diff --git a/source/index.txt b/source/index.txt index ffb46376..8c5007ef 100644 --- a/source/index.txt +++ b/source/index.txt @@ -2,6 +2,9 @@ MongoDB C++ Driver =================== +.. meta:: + :description: Explore the MongoDB C++ Driver, including installation, connection setup, data operations, and advanced configuration options. + .. facet:: :name: genre :values: reference diff --git a/source/testing.txt b/source/testing.txt index 6849418b..8817da7f 100644 --- a/source/testing.txt +++ b/source/testing.txt @@ -4,6 +4,9 @@ Testing ======= +.. meta:: + :description: Learn how to run and write tests for the C++ driver using Catch, including unit and integration tests. + .. contents:: On this page :local: :backlinks: none diff --git a/source/thread-safety.txt b/source/thread-safety.txt index 5beec8cf..3d06dc4d 100644 --- a/source/thread-safety.txt +++ b/source/thread-safety.txt @@ -4,6 +4,9 @@ Thread and Fork Safety ======================= +.. meta:: + :description: Ensure each thread has its own mongocxx::client and avoid sharing client objects across threads to maintain thread safety in C++ MongoDB applications. + .. contents:: On this page :local: :backlinks: none