From 41ee4d2b31c7dc5d5375b55664b1e57c3e399844 Mon Sep 17 00:00:00 2001 From: Nick Larew Date: Thu, 10 Apr 2025 17:39:36 -0500 Subject: [PATCH] Add missing meta descriptions --- source/commands.txt | 3 +++ source/connect.txt | 3 +++ source/create-cluster-terraform.txt | 3 +++ source/create-document-playground.txt | 3 +++ source/crud-ops.txt | 3 +++ source/databases-collections.txt | 3 +++ source/delete-document-playground.txt | 3 +++ source/enable-autocomplete-for-string-literals.txt | 3 +++ source/export-to-language.txt | 3 +++ source/index.txt | 3 +++ source/install.txt | 3 +++ source/install/verify-plugin.txt | 3 +++ source/playground-databases.txt | 3 +++ source/playgrounds.txt | 3 +++ source/read-document-playground.txt | 3 +++ source/reference.txt | 3 +++ source/require-playgrounds.txt | 3 +++ source/require-playgrounds/require-local.txt | 3 +++ source/require-playgrounds/require-modules.txt | 3 +++ source/run-agg-pipelines.txt | 3 +++ source/settings.txt | 3 +++ source/time-series-collections.txt | 3 +++ source/update-document-playground.txt | 3 +++ 23 files changed, 69 insertions(+) diff --git a/source/commands.txt b/source/commands.txt index 02fe42d1..1ebcaa8a 100644 --- a/source/commands.txt +++ b/source/commands.txt @@ -4,6 +4,9 @@ |vscode-short| Commands ======================= +.. meta:: + :description: Explore available VS Code commands for managing MongoDB connections, launching shells, creating playgrounds, and navigating the VS Code Extension view. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/connect.txt b/source/connect.txt index 2fdd23ee..4a4ff00c 100644 --- a/source/connect.txt +++ b/source/connect.txt @@ -4,6 +4,9 @@ Connect to Your MongoDB Deployment ================================== +.. meta:: + :description: Connect to a MongoDB deployment using the VS Code Extension, with options for connection strings and advanced settings. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/create-cluster-terraform.txt b/source/create-cluster-terraform.txt index e2a3017d..b0e12842 100644 --- a/source/create-cluster-terraform.txt +++ b/source/create-cluster-terraform.txt @@ -4,6 +4,9 @@ Create an |service| Cluster from a Template using Terraform =========================================================== +.. meta:: + :description: Create an Atlas cluster using Terraform with the MongoDB VS Code Extension, configure it, and manage it with Terraform commands. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/create-document-playground.txt b/source/create-document-playground.txt index 8ca1ab08..284afdd1 100644 --- a/source/create-document-playground.txt +++ b/source/create-document-playground.txt @@ -4,6 +4,9 @@ Create Documents with VS Code ============================= +.. meta:: + :description: Create documents in a MongoDB collection using VS Code by utilizing the insertOne() and insertMany() methods in a MongoDB Playground. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/crud-ops.txt b/source/crud-ops.txt index 3d34cb21..bf3c61a3 100644 --- a/source/crud-ops.txt +++ b/source/crud-ops.txt @@ -4,6 +4,9 @@ Perform CRUD Operations with VS Code ==================================== +.. meta:: + :description: Use MongoDB Playgrounds in VS Code to perform CRUD operations on documents in a connected deployment. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/databases-collections.txt b/source/databases-collections.txt index 2f422e57..017e3906 100644 --- a/source/databases-collections.txt +++ b/source/databases-collections.txt @@ -4,6 +4,9 @@ Navigate Your Data ================== +.. meta:: + :description: Explore and manage databases, collections, and documents using the MongoDB VS Code Extension, including creating, editing, and dropping data. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/delete-document-playground.txt b/source/delete-document-playground.txt index 870db9a8..fac90b2b 100644 --- a/source/delete-document-playground.txt +++ b/source/delete-document-playground.txt @@ -4,6 +4,9 @@ Delete Documents with VS Code ============================= +.. meta:: + :description: Delete documents in a MongoDB collection using VS Code Playground with deleteOne() and deleteMany() methods. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/enable-autocomplete-for-string-literals.txt b/source/enable-autocomplete-for-string-literals.txt index bb1d5ab5..44f3d35b 100644 --- a/source/enable-autocomplete-for-string-literals.txt +++ b/source/enable-autocomplete-for-string-literals.txt @@ -4,6 +4,9 @@ Enable Autocomplete for String Literals ======================================= +.. meta:: + :description: Enable autocomplete for string literals in VSCode to automatically populate database and collection names in MongoDB playgrounds. + .. contents:: On this page :local: :backlinks: none diff --git a/source/export-to-language.txt b/source/export-to-language.txt index 597c1311..69b1ae39 100644 --- a/source/export-to-language.txt +++ b/source/export-to-language.txt @@ -4,6 +4,9 @@ Export a Query or Pipeline to Language ====================================== +.. meta:: + :description: Export and translate MongoDB queries and aggregation pipelines to various programming languages using the MongoDB Extension for Github Copilot in Visual Studio Code. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/index.txt b/source/index.txt index 577b6ae2..031e6053 100644 --- a/source/index.txt +++ b/source/index.txt @@ -4,6 +4,9 @@ |vsce-full| =========== +.. meta:: + :description: Explore MongoDB data, prototype queries, and create Atlas clusters using the MongoDB extension for Visual Studio Code. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/install.txt b/source/install.txt index 2b248aa9..098ed855 100644 --- a/source/install.txt +++ b/source/install.txt @@ -4,6 +4,9 @@ Install |vsce-full| =================== +.. meta:: + :description: Install the MongoDB for VS Code Extension by searching for it in the Visual Studio Code marketplace and clicking Install. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/install/verify-plugin.txt b/source/install/verify-plugin.txt index 394f9827..42e8ceb4 100644 --- a/source/install/verify-plugin.txt +++ b/source/install/verify-plugin.txt @@ -4,6 +4,9 @@ Verify MongoDB for VSCode Plugin ================================ +.. meta:: + :description: Verify the MongoDB for VSCode plugin by downloading the signature file, importing the public key, and using GPG to ensure the plugin is authentic. + .. contents:: On this page :local: :backlinks: none diff --git a/source/playground-databases.txt b/source/playground-databases.txt index bec0deaf..b514decb 100644 --- a/source/playground-databases.txt +++ b/source/playground-databases.txt @@ -3,6 +3,9 @@ ================================ Create Databases and Collections ================================ + +.. meta:: + :description: Create databases and collections using MongoDB Playground in VS Code by following a template and running the playground. .. default-domain:: mongodb .. contents:: On this page diff --git a/source/playgrounds.txt b/source/playgrounds.txt index b73c1866..7ce8f0ba 100644 --- a/source/playgrounds.txt +++ b/source/playgrounds.txt @@ -4,6 +4,9 @@ Explore Your Data with Playgrounds ================================== +.. meta:: + :description: Explore and prototype MongoDB queries and commands using Playgrounds in VS Code, with features like syntax highlighting, autocomplete, and result editing. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/read-document-playground.txt b/source/read-document-playground.txt index b5d01715..f59308f8 100644 --- a/source/read-document-playground.txt +++ b/source/read-document-playground.txt @@ -4,6 +4,9 @@ Read Documents with VS Code =========================== +.. meta:: + :description: Read documents in a MongoDB collection using the findOne() and find() methods in a VS Code Playground. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/reference.txt b/source/reference.txt index a59fccf8..40bd9d6e 100644 --- a/source/reference.txt +++ b/source/reference.txt @@ -4,6 +4,9 @@ Reference ========= +.. meta:: + :description: Explore the reference materials for MongoDB's VS Code extension. + .. default-domain:: mongodb .. toctree:: diff --git a/source/require-playgrounds.txt b/source/require-playgrounds.txt index 813f5e9b..c6264bab 100644 --- a/source/require-playgrounds.txt +++ b/source/require-playgrounds.txt @@ -4,6 +4,9 @@ Use require() in Playgrounds ============================ +.. meta:: + :description: Utilize the `require()` function in playgrounds to import Node modules or local JavaScript files, enhancing code reuse and organization. + .. contents:: On this page :local: :backlinks: none diff --git a/source/require-playgrounds/require-local.txt b/source/require-playgrounds/require-local.txt index a741d36e..0d10801f 100644 --- a/source/require-playgrounds/require-local.txt +++ b/source/require-playgrounds/require-local.txt @@ -4,6 +4,9 @@ Use require() to Load Local Files ================================= +.. meta:: + :description: Learn how to use `require()` in MongoDB Playgrounds to load local scripts for code reuse, demonstrated with a document validation example. + .. contents:: On this page :local: :backlinks: none diff --git a/source/require-playgrounds/require-modules.txt b/source/require-playgrounds/require-modules.txt index 6e9eef01..cb49a6f4 100644 --- a/source/require-playgrounds/require-modules.txt +++ b/source/require-playgrounds/require-modules.txt @@ -4,6 +4,9 @@ Use require() to Include Node.js Modules ======================================== +.. meta:: + :description: Learn how to use the require() function in MongoDB Playgrounds to include Node.js modules, both native and non-native, for enhanced functionality. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/run-agg-pipelines.txt b/source/run-agg-pipelines.txt index b237b290..5fa760a0 100644 --- a/source/run-agg-pipelines.txt +++ b/source/run-agg-pipelines.txt @@ -4,6 +4,9 @@ Run Aggregation Pipelines with VS Code ====================================== +.. meta:: + :description: Run aggregation pipelines in VS Code using MongoDB Playgrounds to process and compute data results directly within the editor. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/settings.txt b/source/settings.txt index 65e335d4..45f218f2 100644 --- a/source/settings.txt +++ b/source/settings.txt @@ -4,6 +4,9 @@ |vscode-short| Settings ======================= +.. meta:: + :description: Explore configurable settings for the VS Code Extension, including shell selection, view options, problem limits, and connection saving preferences. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/time-series-collections.txt b/source/time-series-collections.txt index e12ac021..d8a1a186 100644 --- a/source/time-series-collections.txt +++ b/source/time-series-collections.txt @@ -4,6 +4,9 @@ Create Time Series Collections with VS Code =========================================== +.. meta:: + :description: Create time series collections in MongoDB using VS Code by following a step-by-step guide in a MongoDB Playground. + .. default-domain:: mongodb .. contents:: On this page diff --git a/source/update-document-playground.txt b/source/update-document-playground.txt index fef9ede5..e6ee4acf 100644 --- a/source/update-document-playground.txt +++ b/source/update-document-playground.txt @@ -4,6 +4,9 @@ Update Documents with VS Code ============================= +.. meta:: + :description: Update documents in a MongoDB collection using VS Code Playground with updateOne() and updateMany() methods. + .. default-domain:: mongodb .. contents:: On this page