diff --git a/source/changelog.txt b/source/changelog.txt index 84961497..164c0a90 100644 --- a/source/changelog.txt +++ b/source/changelog.txt @@ -4,6 +4,9 @@ Release Notes ============= +.. meta:: + :description: Explore the changelog for `mongosh`, detailing new features, bug fixes, and updates across various versions. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/field-level-encryption.txt b/source/field-level-encryption.txt index 3600c39c..35fd3cf6 100644 --- a/source/field-level-encryption.txt +++ b/source/field-level-encryption.txt @@ -4,6 +4,9 @@ Client-Side Field Level Encryption ================================== +.. meta:: + :description: Configure client-side field level encryption in `mongosh` for MongoDB clusters using various KMS providers like AWS, Azure, GCP, or a local keyfile. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/install/verify-signatures.txt b/source/install/verify-signatures.txt index 4053a6ef..2506208d 100644 --- a/source/install/verify-signatures.txt +++ b/source/install/verify-signatures.txt @@ -4,6 +4,9 @@ Verify Integrity of MongoDB Shell Packages ========================================== +.. meta:: + :description: Verify the integrity of MongoDB Shell packages using digital signatures before installation. + .. contents:: On this page :local: :backlinks: none diff --git a/source/install/verify-signatures/disk-images.txt b/source/install/verify-signatures/disk-images.txt index 09b8c896..3fbf36c9 100644 --- a/source/install/verify-signatures/disk-images.txt +++ b/source/install/verify-signatures/disk-images.txt @@ -4,6 +4,9 @@ Verify Packages with Disk Image Verification (macOS) ==================================================== +.. meta:: + :description: Verify MongoDB Shell packages on macOS using digital signatures to ensure authenticity and integrity before installation. + .. contents:: On this page :local: :backlinks: none diff --git a/source/install/verify-signatures/gpg.txt b/source/install/verify-signatures/gpg.txt index 11ecd049..d3c76f9b 100644 --- a/source/install/verify-signatures/gpg.txt +++ b/source/install/verify-signatures/gpg.txt @@ -4,6 +4,9 @@ Verify Packages with GPG (Linux and macOS) ========================================== +.. meta:: + :description: Verify MongoDB Shell packages on Linux and macOS using GPG to ensure they are valid and unaltered releases. + .. contents:: On this page :local: :backlinks: none diff --git a/source/install/verify-signatures/rpm.txt b/source/install/verify-signatures/rpm.txt index b158c499..286b91be 100644 --- a/source/install/verify-signatures/rpm.txt +++ b/source/install/verify-signatures/rpm.txt @@ -4,6 +4,9 @@ Verify RPM Packages (RHEL) ========================== +.. meta:: + :description: Verify the digital signatures of MongoDB Shell RPM packages on RHEL to ensure they are valid and unaltered before installation. + .. contents:: On this page :local: :backlinks: none diff --git a/source/install/verify-signatures/windows.txt b/source/install/verify-signatures/windows.txt index f975ee47..ed48ff40 100644 --- a/source/install/verify-signatures/windows.txt +++ b/source/install/verify-signatures/windows.txt @@ -4,6 +4,9 @@ Verify Windows Packages ======================= +.. meta:: + :description: Verify the authenticity of MongoDB Shell packages on Windows using PowerShell or by checking digital signatures in the properties. + .. contents:: On this page :local: :backlinks: none diff --git a/source/logs.txt b/source/logs.txt index 15e00103..b5a19b0a 100644 --- a/source/logs.txt +++ b/source/logs.txt @@ -4,6 +4,9 @@ Shell Logs ========== +.. meta:: + :description: Access and manage MongoDB Shell session logs, including viewing, customizing, and setting retention policies. + .. contents:: On this page :local: :backlinks: none diff --git a/source/mongoshrc.txt b/source/mongoshrc.txt index 85180dac..b7e8e68b 100644 --- a/source/mongoshrc.txt +++ b/source/mongoshrc.txt @@ -4,6 +4,9 @@ ``.mongoshrc`` Configuration File ================================= +.. meta:: + :description: Customize `mongosh` startup behavior using the `.mongoshrc.js` file in your `HOME` directory, with options to prevent loading or rename legacy files. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/reference.txt b/source/reference.txt index 63ba93f5..ab59ae0a 100644 --- a/source/reference.txt +++ b/source/reference.txt @@ -2,6 +2,9 @@ Reference ========= +.. meta:: + :description: Explore the reference materials for MongoDB Shell. + .. default-domain:: mongodb .. toctree:: diff --git a/source/reference/access-mdb-shell-help.txt b/source/reference/access-mdb-shell-help.txt index 963cc000..d88e0775 100644 --- a/source/reference/access-mdb-shell-help.txt +++ b/source/reference/access-mdb-shell-help.txt @@ -5,6 +5,9 @@ ``mongosh`` Help ================ +.. meta:: + :description: Access help in `mongosh` using commands like `help`, `db.help()`, and `show collections` to explore available methods and database information. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/reference/compatibility.txt b/source/reference/compatibility.txt index 13743b8d..785b98e1 100644 --- a/source/reference/compatibility.txt +++ b/source/reference/compatibility.txt @@ -4,6 +4,9 @@ Compatibility Changes with Legacy ``mongo`` Shell ================================================= +.. meta:: + :description: Explore the differences between `mongosh` and the legacy `mongo` shell, including deprecated methods, read and write preference behaviors, and data type handling. + .. contents:: On this page :local: :backlinks: none diff --git a/source/reference/configure-shell-settings-api.txt b/source/reference/configure-shell-settings-api.txt index a702fc61..3c0b1758 100644 --- a/source/reference/configure-shell-settings-api.txt +++ b/source/reference/configure-shell-settings-api.txt @@ -4,6 +4,9 @@ Configure Settings Using the API ================================ +.. meta:: + :description: Configure and manage `mongosh` settings using the `config` API to persist changes across sessions, including setting properties like logging and telemetry. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/reference/configure-shell-settings-global.txt b/source/reference/configure-shell-settings-global.txt index eae29cc6..4273ab59 100644 --- a/source/reference/configure-shell-settings-global.txt +++ b/source/reference/configure-shell-settings-global.txt @@ -4,6 +4,9 @@ Configure Settings Using a Configuration File ============================================= +.. meta:: + :description: Configure `mongosh` settings using a YAML configuration file to apply settings like `displayBatchSize` and `inspectDepth` at startup, with options to override using the config API. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/reference/configure-shell-settings.txt b/source/reference/configure-shell-settings.txt index 50b1ad8d..4ce9d9be 100644 --- a/source/reference/configure-shell-settings.txt +++ b/source/reference/configure-shell-settings.txt @@ -4,6 +4,9 @@ Configure Settings ================== +.. meta:: + :description: Configure `mongosh` settings to customize shell behaviors, including logging, telemetry, and history management, using the config API or a global configuration file. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/reference/customize-prompt.txt b/source/reference/customize-prompt.txt index 026cf156..a7bfe197 100644 --- a/source/reference/customize-prompt.txt +++ b/source/reference/customize-prompt.txt @@ -4,6 +4,9 @@ Customize the :binary:`~bin.mongosh` Prompt =========================================== +.. meta:: + :description: Customize the `mongosh` prompt to display dynamic session information, such as line numbers, database and hostname, or system uptime and document count. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/reference/data-types.txt b/source/reference/data-types.txt index 14d3f64e..fe92f384 100644 --- a/source/reference/data-types.txt +++ b/source/reference/data-types.txt @@ -4,6 +4,9 @@ Data Types ========== +.. meta:: + :description: Explore the data types supported by MongoDB's BSON, including Date, ObjectId, Double, Int32, Long, Decimal128, and Timestamp, with examples and type checking methods. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/reference/editor-mode.txt b/source/reference/editor-mode.txt index 58ac823d..eaba2e0e 100644 --- a/source/reference/editor-mode.txt +++ b/source/reference/editor-mode.txt @@ -5,6 +5,9 @@ Use an Editor for Commands ========================== +.. meta:: + :description: Learn to use external or built-in editors in `mongosh` for multiline command editing, including setting up and using editors like `vi`, `nano`, or Visual Studio. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/reference/methods.txt b/source/reference/methods.txt index 88e8757a..a54f8bc0 100644 --- a/source/reference/methods.txt +++ b/source/reference/methods.txt @@ -4,6 +4,9 @@ Methods ======= +.. meta:: + :description: Explore the available methods in the MongoDB Shell, including administration, bulk operations, collection management, and more, with detailed descriptions and usage. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/reference/options.txt b/source/reference/options.txt index a1424c60..52c55f2c 100644 --- a/source/reference/options.txt +++ b/source/reference/options.txt @@ -2,6 +2,9 @@ Options ======= +.. meta:: + :description: Explore various options to control MongoDB Shell, including general, stable API, connection, authentication, session, and client-side field level encryption options. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/run-agg-pipelines.txt b/source/run-agg-pipelines.txt index 698c828b..c5a21833 100644 --- a/source/run-agg-pipelines.txt +++ b/source/run-agg-pipelines.txt @@ -4,6 +4,9 @@ Run Aggregation Pipelines ========================= +.. meta:: + :description: Run aggregation pipelines in MongoDB Shell to transform documents into aggregated results using various stages like grouping, filtering, and sorting. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/snippets.txt b/source/snippets.txt index f1116151..84eec835 100644 --- a/source/snippets.txt +++ b/source/snippets.txt @@ -4,6 +4,9 @@ Snippets ======== +.. meta:: + :description: Explore how to use, create, and manage snippets in `mongosh` for data manipulation and administrative tasks. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/snippets/commands.txt b/source/snippets/commands.txt index 6839f2e3..d2eca9fe 100644 --- a/source/snippets/commands.txt +++ b/source/snippets/commands.txt @@ -4,6 +4,9 @@ Snippet Commands ================ +.. meta:: + :description: Explore available commands for managing snippets, including installing, listing, and updating snippets in the MongoDB Shell. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/snippets/configuration.txt b/source/snippets/configuration.txt index 16d5f4be..bbb115e5 100644 --- a/source/snippets/configuration.txt +++ b/source/snippets/configuration.txt @@ -4,6 +4,9 @@ Configuration Options ===================== +.. meta:: + :description: Configure `mongosh` snippet settings, including autoload and registry URLs, using the `config.set` method. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/snippets/error-handlers.txt b/source/snippets/error-handlers.txt index 3254b358..835f6771 100644 --- a/source/snippets/error-handlers.txt +++ b/source/snippets/error-handlers.txt @@ -4,6 +4,9 @@ Error Handlers ============== +.. meta:: + :description: Explore how to use error handlers with regular expressions to catch runtime errors and display custom messages in MongoDB Shell. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/snippets/packages.txt b/source/snippets/packages.txt index 1d77ef0f..e2803736 100644 --- a/source/snippets/packages.txt +++ b/source/snippets/packages.txt @@ -4,6 +4,9 @@ Create and Share Snippets ========================= +.. meta:: + :description: Learn how to create, package, and share MongoDB shell snippets, including preparing files, publishing to a registry, and contributing to the community. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/snippets/reference.txt b/source/snippets/reference.txt index d6ab84a6..cc588a34 100644 --- a/source/snippets/reference.txt +++ b/source/snippets/reference.txt @@ -4,6 +4,9 @@ Snippets Reference ================== +.. meta:: + :description: Explore available commands for working with snippets in `mongosh`, including package management and error handling options. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/snippets/registries-config.txt b/source/snippets/registries-config.txt index e35e261e..a51efcca 100644 --- a/source/snippets/registries-config.txt +++ b/source/snippets/registries-config.txt @@ -4,6 +4,9 @@ Registries and Registry Configuration ===================================== +.. meta:: + :description: Configure your system to use different registries for MongoDB snippets, including community, private, and multiple registries. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/snippets/registry-index.txt b/source/snippets/registry-index.txt index 0ab408d0..5546479a 100644 --- a/source/snippets/registry-index.txt +++ b/source/snippets/registry-index.txt @@ -5,6 +5,9 @@ Create a Registry Index File Manually ===================================== +.. meta:: + :description: Learn how to manually create a registry index file for MongoDB Shell snippets using TypeScript. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/snippets/troubleshooting.txt b/source/snippets/troubleshooting.txt index d07dec0a..296757e2 100644 --- a/source/snippets/troubleshooting.txt +++ b/source/snippets/troubleshooting.txt @@ -4,6 +4,9 @@ Troubleshooting =============== +.. meta:: + :description: Troubleshoot common issues with MongoDB Shell snippets, including viewing npm logs and resolving module errors. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/snippets/working-with-snippets.txt b/source/snippets/working-with-snippets.txt index d14566f8..8712f31e 100644 --- a/source/snippets/working-with-snippets.txt +++ b/source/snippets/working-with-snippets.txt @@ -4,6 +4,9 @@ Use Snippets in the Console =========================== +.. meta:: + :description: Learn how to install, run, and manage snippets in the `mongosh` console, including searching for available snippets and getting help for specific ones. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/telemetry.txt b/source/telemetry.txt index c9f27455..f6ad95b8 100644 --- a/source/telemetry.txt +++ b/source/telemetry.txt @@ -4,6 +4,9 @@ Configure Telemetry Options =========================== +.. meta:: + :description: Configure telemetry options in `mongosh` to manage anonymous usage data collection, with options to enable or disable it at any time. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/write-scripts/considerations.txt b/source/write-scripts/considerations.txt index 74705e29..f7ea8ee8 100644 --- a/source/write-scripts/considerations.txt +++ b/source/write-scripts/considerations.txt @@ -5,6 +5,9 @@ Script Considerations ===================== +.. meta:: + :description: Consider using async functions, async generator functions, or `.map()` for database query results in scripts, as certain contexts like class constructors and non-async generators are unsupported. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/write-scripts/require-external-modules.txt b/source/write-scripts/require-external-modules.txt index 2904de7e..29a6f375 100644 --- a/source/write-scripts/require-external-modules.txt +++ b/source/write-scripts/require-external-modules.txt @@ -4,6 +4,9 @@ Include External Files and Modules in Scripts ============================================= +.. meta:: + :description: Learn how to include external files and modules in `mongosh` scripts using the `require()` function for local files, built-in Node.js modules, and npm modules. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/write-scripts/require-load-differences.txt b/source/write-scripts/require-load-differences.txt index 22e2b487..a1d32d27 100644 --- a/source/write-scripts/require-load-differences.txt +++ b/source/write-scripts/require-load-differences.txt @@ -4,6 +4,9 @@ Differences Between ``require()`` and ``load()`` ================================================ +.. meta:: + :description: Understand the differences between `require()` and `load()` in mongosh scripts, including their availability, file path handling, and packaging considerations. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/write-scripts/scoping.txt b/source/write-scripts/scoping.txt index 97ce1cdb..42dcaa6d 100644 --- a/source/write-scripts/scoping.txt +++ b/source/write-scripts/scoping.txt @@ -4,6 +4,9 @@ Code Scoping ============ +.. meta:: + :description: Learn how to manage code scope in `mongosh` to prevent global scope collisions by wrapping functions and variables within an anonymous function. + .. default-domain:: mongodb .. contents:: On this page