Skip to content

Commit 0b0714f

Browse files
nlarewnlarew
authored
Add missing meta descriptions (#401)
1 parent 351237e commit 0b0714f

36 files changed

+108
-0
lines changed

‎source/changelog.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Release Notes
55
=============
66

7+
.. meta::
8+
:description: Explore the changelog for `mongosh`, detailing new features, bug fixes, and updates across various versions.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

‎source/field-level-encryption.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Client-Side Field Level Encryption
55
==================================
66

7+
.. meta::
8+
:description: Configure client-side field level encryption in `mongosh` for MongoDB clusters using various KMS providers like AWS, Azure, GCP, or a local keyfile.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

‎source/install/verify-signatures.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Verify Integrity of MongoDB Shell Packages
55
==========================================
66

7+
.. meta::
8+
:description: Verify the integrity of MongoDB Shell packages using digital signatures before installation.
9+
710
.. contents:: On this page
811
:local:
912
:backlinks: none

‎source/install/verify-signatures/disk-images.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Verify Packages with Disk Image Verification (macOS)
55
====================================================
66

7+
.. meta::
8+
:description: Verify MongoDB Shell packages on macOS using digital signatures to ensure authenticity and integrity before installation.
9+
710
.. contents:: On this page
811
:local:
912
:backlinks: none

‎source/install/verify-signatures/gpg.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Verify Packages with GPG (Linux and macOS)
55
==========================================
66

7+
.. meta::
8+
:description: Verify MongoDB Shell packages on Linux and macOS using GPG to ensure they are valid and unaltered releases.
9+
710
.. contents:: On this page
811
:local:
912
:backlinks: none

‎source/install/verify-signatures/rpm.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Verify RPM Packages (RHEL)
55
==========================
66

7+
.. meta::
8+
:description: Verify the digital signatures of MongoDB Shell RPM packages on RHEL to ensure they are valid and unaltered before installation.
9+
710
.. contents:: On this page
811
:local:
912
:backlinks: none

‎source/install/verify-signatures/windows.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Verify Windows Packages
55
=======================
66

7+
.. meta::
8+
:description: Verify the authenticity of MongoDB Shell packages on Windows using PowerShell or by checking digital signatures in the properties.
9+
710
.. contents:: On this page
811
:local:
912
:backlinks: none

‎source/logs.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Shell Logs
55
==========
66

7+
.. meta::
8+
:description: Access and manage MongoDB Shell session logs, including viewing, customizing, and setting retention policies.
9+
710
.. contents:: On this page
811
:local:
912
:backlinks: none

‎source/mongoshrc.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
``.mongoshrc`` Configuration File
55
=================================
66

7+
.. meta::
8+
:description: Customize `mongosh` startup behavior using the `.mongoshrc.js` file in your `HOME` directory, with options to prevent loading or rename legacy files.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

‎source/reference.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
Reference
33
=========
44

5+
.. meta::
6+
:description: Explore the reference materials for MongoDB Shell.
7+
58
.. default-domain:: mongodb
69

710
.. toctree::

‎source/reference/access-mdb-shell-help.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
``mongosh`` Help
66
================
77

8+
.. meta::
9+
:description: Access help in `mongosh` using commands like `help`, `db.help()`, and `show collections` to explore available methods and database information.
10+
811
.. default-domain:: mongodb
912

1013
.. contents:: On this page

‎source/reference/compatibility.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Compatibility Changes with Legacy ``mongo`` Shell
55
=================================================
66

7+
.. meta::
8+
:description: Explore the differences between `mongosh` and the legacy `mongo` shell, including deprecated methods, read and write preference behaviors, and data type handling.
9+
710
.. contents:: On this page
811
:local:
912
:backlinks: none

‎source/reference/configure-shell-settings-api.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Configure Settings Using the API
55
================================
66

7+
.. meta::
8+
:description: Configure and manage `mongosh` settings using the `config` API to persist changes across sessions, including setting properties like logging and telemetry.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

‎source/reference/configure-shell-settings-global.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Configure Settings Using a Configuration File
55
=============================================
66

7+
.. meta::
8+
: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.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

‎source/reference/configure-shell-settings.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Configure Settings
55
==================
66

7+
.. meta::
8+
:description: Configure `mongosh` settings to customize shell behaviors, including logging, telemetry, and history management, using the config API or a global configuration file.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

‎source/reference/customize-prompt.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Customize the :binary:`~bin.mongosh` Prompt
55
===========================================
66

7+
.. meta::
8+
:description: Customize the `mongosh` prompt to display dynamic session information, such as line numbers, database and hostname, or system uptime and document count.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

‎source/reference/data-types.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Data Types
55
==========
66

7+
.. meta::
8+
: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.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

‎source/reference/editor-mode.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
Use an Editor for Commands
66
==========================
77

8+
.. meta::
9+
: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.
10+
811
.. default-domain:: mongodb
912

1013
.. contents:: On this page

‎source/reference/methods.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Methods
55
=======
66

7+
.. meta::
8+
:description: Explore the available methods in the MongoDB Shell, including administration, bulk operations, collection management, and more, with detailed descriptions and usage.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

‎source/reference/options.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
Options
33
=======
44

5+
.. meta::
6+
:description: Explore various options to control MongoDB Shell, including general, stable API, connection, authentication, session, and client-side field level encryption options.
7+
58
.. default-domain:: mongodb
69

710
.. contents:: On this page

‎source/run-agg-pipelines.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Run Aggregation Pipelines
55
=========================
66

7+
.. meta::
8+
:description: Run aggregation pipelines in MongoDB Shell to transform documents into aggregated results using various stages like grouping, filtering, and sorting.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

‎source/snippets.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Snippets
55
========
66

7+
.. meta::
8+
:description: Explore how to use, create, and manage snippets in `mongosh` for data manipulation and administrative tasks.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

‎source/snippets/commands.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Snippet Commands
55
================
66

7+
.. meta::
8+
:description: Explore available commands for managing snippets, including installing, listing, and updating snippets in the MongoDB Shell.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

‎source/snippets/configuration.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Configuration Options
55
=====================
66

7+
.. meta::
8+
:description: Configure `mongosh` snippet settings, including autoload and registry URLs, using the `config.set` method.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

‎source/snippets/error-handlers.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Error Handlers
55
==============
66

7+
.. meta::
8+
:description: Explore how to use error handlers with regular expressions to catch runtime errors and display custom messages in MongoDB Shell.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

‎source/snippets/packages.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Create and Share Snippets
55
=========================
66

7+
.. meta::
8+
:description: Learn how to create, package, and share MongoDB shell snippets, including preparing files, publishing to a registry, and contributing to the community.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

‎source/snippets/reference.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Snippets Reference
55
==================
66

7+
.. meta::
8+
:description: Explore available commands for working with snippets in `mongosh`, including package management and error handling options.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

‎source/snippets/registries-config.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Registries and Registry Configuration
55
=====================================
66

7+
.. meta::
8+
:description: Configure your system to use different registries for MongoDB snippets, including community, private, and multiple registries.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

‎source/snippets/registry-index.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
Create a Registry Index File Manually
66
=====================================
77

8+
.. meta::
9+
:description: Learn how to manually create a registry index file for MongoDB Shell snippets using TypeScript.
10+
811
.. default-domain:: mongodb
912

1013
.. contents:: On this page

‎source/snippets/troubleshooting.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Troubleshooting
55
===============
66

7+
.. meta::
8+
:description: Troubleshoot common issues with MongoDB Shell snippets, including viewing npm logs and resolving module errors.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

‎source/snippets/working-with-snippets.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Use Snippets in the Console
55
===========================
66

7+
.. meta::
8+
:description: Learn how to install, run, and manage snippets in the `mongosh` console, including searching for available snippets and getting help for specific ones.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

‎source/telemetry.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Configure Telemetry Options
55
===========================
66

7+
.. meta::
8+
:description: Configure telemetry options in `mongosh` to manage anonymous usage data collection, with options to enable or disable it at any time.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

‎source/write-scripts/considerations.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
Script Considerations
66
=====================
77

8+
.. meta::
9+
: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.
10+
811
.. default-domain:: mongodb
912

1013
.. contents:: On this page

‎source/write-scripts/require-external-modules.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Include External Files and Modules in Scripts
55
=============================================
66

7+
.. meta::
8+
: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.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

‎source/write-scripts/require-load-differences.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Differences Between ``require()`` and ``load()``
55
================================================
66

7+
.. meta::
8+
:description: Understand the differences between `require()` and `load()` in mongosh scripts, including their availability, file path handling, and packaging considerations.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

‎source/write-scripts/scoping.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Code Scoping
55
============
66

7+
.. meta::
8+
:description: Learn how to manage code scope in `mongosh` to prevent global scope collisions by wrapping functions and variables within an anonymous function.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

0 commit comments

Comments
 (0)