Merge pull request #456 from mongodb/missing-meta-descriptions

JuliaMongo · web-flow · commit f552ade6a76f · 2025-04-11T13:48:30.000-04:00
Add missing meta descriptions
diff --git a/source/authentication.txt b/source/authentication.txt
@@ -4,6 +4,9 @@
 Authentication
 ==============
 
+.. meta::
+   :description: Configure authentication for the MongoDB BI Connector using mechanisms like SCRAM, LDAP, and Kerberos, and learn how to set up client authentication.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/client-applications.txt b/source/client-applications.txt
@@ -2,6 +2,9 @@
 Connect BI Tools
 ================
 
+.. meta::
+   :description: Connect BI tools like Tableau, Power BI, and Excel to BI Connector using ODBC and JDBC drivers.
+
 .. default-domain:: mongodb
 
 After you install and configure the |bi-short|, you can use |odbc| and
diff --git a/source/components.txt b/source/components.txt
@@ -2,6 +2,9 @@
 MongoDB Connector for BI Components
 ===================================
 
+.. meta::
+   :description: Explore the tools and drivers available for the MongoDB Connector for BI, including `mongodrdl`, `mongosqld`, and various authentication plugins.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/connect/excel.txt b/source/connect/excel.txt
@@ -4,6 +4,9 @@
 Connect from Microsoft Excel
 ============================
 
+.. meta::
+   :description: Import data from a MongoDB collection into Microsoft Excel using the MongoDB Connector for BI and an ODBC data connection.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/connect/mysql.txt b/source/connect/mysql.txt
@@ -4,6 +4,9 @@
 Connect from the MySQL Client
 =============================
 
+.. meta::
+   :description: Connect to the MongoDB Connector for BI using the MySQL client with options for authentication and TLS/SSL.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/connect/powerbi.txt b/source/connect/powerbi.txt
@@ -4,6 +4,9 @@
 Connect from Microsoft Power BI Desktop
 =======================================
 
+.. meta::
+   :description: Connect to the MongoDB Connector for BI using Microsoft Power BI Desktop by setting up an ODBC Data Source Name and selecting your data.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/connect/qlik.txt b/source/connect/qlik.txt
@@ -4,6 +4,9 @@
 Connect from Qlik Sense
 =======================
 
+.. meta::
+   :description: Learn to connect Qlik Sense to MongoDB Connector for BI by creating a 64-bit system DSN and setting up a new app.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/connect/tableau-auth-ssl.txt b/source/connect/tableau-auth-ssl.txt
@@ -6,6 +6,9 @@
 Connect from Tableau Desktop with Authentication and TLS/SSL
 ============================================================
 
+.. meta::
+   :description: Connect Tableau Desktop to the MongoDB Connector for BI using authentication and TLS/SSL by configuring a system DSN with the ODBC driver.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/connect/tableau-auth.txt b/source/connect/tableau-auth.txt
@@ -6,6 +6,9 @@
 Connect from Tableau Desktop with Authentication
 ================================================
 
+.. meta::
+   :description: Connect Tableau Desktop to the MongoDB Connector for BI using authentication by setting up a system DSN with the ODBC driver and configuring connection parameters.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/connect/tableau-no-auth.txt b/source/connect/tableau-no-auth.txt
@@ -6,6 +6,9 @@
 Connect from Tableau Desktop without Authentication or TLS/SSL
 ==============================================================
 
+.. meta::
+   :description: Connect Tableau Desktop to MongoDB BI Connector without authentication or TLS/SSL by setting up a system DSN using the ODBC driver.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/connect/tableau.txt b/source/connect/tableau.txt
@@ -4,6 +4,9 @@
 Connect from Tableau Desktop
 ============================
 
+.. meta::
+   :description: Find instructions to connect Tableau Desktop to MongoDB instances with or without authentication and TLS/SSL.
+
 .. default-domain:: mongodb
 
 Connect without Authentication
diff --git a/source/faq.txt b/source/faq.txt
@@ -2,6 +2,9 @@
 FAQ: The MongoDB Connector for BI
 =================================
 
+.. meta::
+   :description: Find answers to common questions about the MongoDB Connector for BI, including authentication, data processing, and using TLS/SSL.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/index.txt b/source/index.txt
@@ -6,6 +6,9 @@
 What is the MongoDB Connector for BI
 ====================================
 
+.. meta::
+   :description: Query MongoDB data with SQL using the Connector for BI to integrate with tools like Tableau, Power BI, and Excel.
+
 .. introduction::
 
    Traditional business intelligence tools are designed to work with
diff --git a/source/installation.txt b/source/installation.txt
@@ -6,6 +6,9 @@
 Install {+bi-short+} On Premises
 ================================
 
+.. meta::
+   :description: Install the BI Connector on premises with platform-specific guides for Windows, macOS, RHEL-based, and Debian-based systems.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/launch.txt b/source/launch.txt
@@ -4,6 +4,9 @@
 Launch {+bi-short+}
 ===================
 
+.. meta::
+   :description: Launch the BI Connector using `mongosqld` to connect MongoDB to BI tools, with options for schema creation and running as a service.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/local-quickstart.txt b/source/local-quickstart.txt
@@ -4,6 +4,9 @@
 Quick Start Guide for Windows
 =============================
 
+.. meta::
+   :description: Set up the BI Connector on Windows using ODBC, including starting `mongod` and `mongosqld` processes, installing the driver, and connecting with a BI tool.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/reference.txt b/source/reference.txt
@@ -2,6 +2,9 @@
 Reference
 =========
 
+.. meta::
+   :description: Find reference materials for the BI Connector.
+
 .. default-domain:: mongodb
 
 .. toctree::
diff --git a/source/reference/auth-plugin-c-mysql-options.txt b/source/reference/auth-plugin-c-mysql-options.txt
@@ -4,6 +4,9 @@
 MySQL Shell Options
 ===================
 
+.. meta::
+   :description: Explore MySQL command-line options for use with the C Authentication Plugin, `mongosql_auth`, including user authentication and plugin directory settings.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/reference/auth-plugin-c.txt b/source/reference/auth-plugin-c.txt
@@ -2,6 +2,9 @@
 C Authentication Plugin
 =======================
 
+.. meta::
+   :description: Install and use the C Authentication Plugin for MongoDB BI Connector to authenticate with various mechanisms like SCRAM-SHA and LDAP.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/reference/auth-plugin-jdbc.txt b/source/reference/auth-plugin-jdbc.txt
@@ -2,6 +2,9 @@
 JDBC Authentication Plugin
 ==========================
 
+.. meta::
+   :description: Integrate MySQL's Connector/J JDBC driver with MongoDB BI Connector using the `mongosql_auth` plugin for various authentication mechanisms.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/reference/drdl.txt b/source/reference/drdl.txt
@@ -2,6 +2,9 @@
 Document Relational Definition Language
 =======================================
 
+.. meta::
+   :description: Define a relational view of a MongoDB schema using Document Relational Definition Language (DRDL) to enable MySQL clients to query MongoDB data.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/reference/jdbc-driver.txt b/source/reference/jdbc-driver.txt
@@ -6,6 +6,9 @@
 {+jdbc-driver+}
 ============================
 
+.. meta::
+   :description: Use the MySQL Connector/J version 5.1.x for JDBC connectivity with the BI Connector, with a minimum supported version of 5.1.44.
+
 .. default-domain:: mongodb
 
 
diff --git a/source/reference/known-issues.txt b/source/reference/known-issues.txt
@@ -2,6 +2,9 @@
 Known Issues for |bi|
 =====================
 
+.. meta::
+   :description: Understand the known issues with SQL compatibility and mapping errors in the BI Connector, including differences in handling `NULL` values and empty sets.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/reference/log-messages.txt b/source/reference/log-messages.txt
@@ -2,6 +2,9 @@
 Log Messages
 ============
 
+.. meta::
+   :description: Understand the format and components of `mongosqld` log messages, including severity levels, components, and how to configure log verbosity.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/reference/odbc-driver.txt b/source/reference/odbc-driver.txt
@@ -4,6 +4,9 @@
 {+odbc-driver-name+}
 =================================
 
+.. meta::
+   :description: Connect SQL clients to the BI Connector using the MongoDB BI Connector ODBC Driver, compatible with various platforms and supporting authentication mechanisms.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/reference/system-variables.txt b/source/reference/system-variables.txt
@@ -4,6 +4,9 @@
 System Variables
 ----------------
 
+.. meta::
+   :description: Explore the system variables available for BI Connector, including their data types, descriptions, and default values, and learn how to set them.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/reference/type-conversion.txt b/source/reference/type-conversion.txt
@@ -4,6 +4,9 @@
 Type Conversion Modes
 =====================
 
+.. meta::
+   :description: Configure type conversion modes in the BI Connector to optimize SQL query translation into MongoDB aggregation pipelines, enhancing performance.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/reference/user-authorization.txt b/source/reference/user-authorization.txt
@@ -4,6 +4,9 @@
 User Authorization Model
 ========================
 
+.. meta::
+   :description: Understand the user authorization model for the BI Connector, mapping SQL statements and MySQL privileges to required MongoDB privileges.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/release-notes.txt b/source/release-notes.txt
@@ -2,6 +2,9 @@
 Release Notes for |bi|
 ======================
 
+.. meta::
+   :description: Explore the latest updates and improvements in the MongoDB Connector for BI, including new features, bug fixes, and compatibility changes across various versions.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/schema-configuration.txt b/source/schema-configuration.txt
@@ -4,6 +4,9 @@
 Map Relational Schemas to MongoDB
 =================================
 
+.. meta::
+   :description: Map relational schemas to MongoDB using BI Connector, which provides methods for creating and managing relational schemas for business intelligence tools.
+
 .. default-domain:: mongodb
 
 Business intelligence tools connect to a data source and, given a fixed
diff --git a/source/schema/cached-sampling.txt b/source/schema/cached-sampling.txt
@@ -4,6 +4,9 @@
 Standalone Schema Mode (Cached Sampling)
 ========================================
 
+.. meta::
+   :description: Learn how to use cached sampling in standalone schema mode with `mongosqld`, including setting user permissions and configuring schema refresh intervals.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/schema/geospatial-data.txt b/source/schema/geospatial-data.txt
@@ -4,6 +4,9 @@
 Geospatial Data
 ===============
 
+.. meta::
+   :description: Understand how BI Connector maps geospatial indexes into numeric longitude-latitude arrays in MongoDB collections.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/schema/load-schema-from-drdl.txt b/source/schema/load-schema-from-drdl.txt
@@ -4,6 +4,9 @@
 Load a Schema from a DRDL File
 ==============================
 
+.. meta::
+   :description: Load and edit a schema from a DRDL file for use with BI Connector, and apply changes by restarting `mongosqld`.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/schema/persist-schema.txt b/source/schema/persist-schema.txt
@@ -4,6 +4,9 @@
 Auto Schema Mode (Persist a Schema in MongoDB)
 ==============================================
 
+.. meta::
+   :description: Persist a schema in MongoDB using `mongosqld` with options for schema storage, automatic resampling, and user permissions.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/schema/resample-schema.txt b/source/schema/resample-schema.txt
@@ -4,6 +4,9 @@
 Resample Schema Data with "FLUSH SAMPLE"
 ========================================
 
+.. meta::
+   :description: Regenerate the schema used by BI Connector with the `FLUSH SAMPLE` command or by restarting `mongosqld` to accommodate significant data shape changes.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/schema/schema-management-changes.txt b/source/schema/schema-management-changes.txt
@@ -4,6 +4,9 @@
 Schema Management Changes in 2.11
 =================================
 
+.. meta::
+   :description: Update your BI Connector configuration to version 2.11 for improved schema management, with changes in standalone, custom, and auto modes.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/schema/type-conflicts.txt b/source/schema/type-conflicts.txt
@@ -4,6 +4,9 @@
 Sampling Type Conflicts
 =======================
 
+.. meta::
+   :description: Resolve type conflicts in MongoDB fields using BI Connector by sampling data and generating relational schemas for scalar and composite types.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/schema/use-views.txt b/source/schema/use-views.txt
@@ -4,6 +4,9 @@
 Use MongoDB Views
 =================
 
+.. meta::
+   :description: Use views to control data visibility for BI Connector, allowing field selection, renaming, sorting, and transformations without a .drdl file.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/supported-operations.txt b/source/supported-operations.txt
@@ -2,6 +2,9 @@
 Supported SQL Functions and Operators
 =====================================
 
+.. meta::
+   :description: Explore the supported SQL functions, operators, and statements in the MongoDB Connector for BI, including comparison, logical, and string functions.
+
 .. default-domain:: mongodb
 
 The following tables list the various MySQL functions, constructors, and
diff --git a/source/tutorial/create-system-dsn.txt b/source/tutorial/create-system-dsn.txt
@@ -4,6 +4,9 @@
 Create a System DSN
 ===================
 
+.. meta::
+   :description: Create a system DSN for the BI Connector's `mongosqld` process to configure SQL clients and BI tools for MongoDB data import.
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/source/tutorial/install-bi-connector-debian.txt b/source/tutorial/install-bi-connector-debian.txt
diff --git a/source/tutorial/install-bi-connector-macos.txt b/source/tutorial/install-bi-connector-macos.txt
diff --git a/source/tutorial/install-bi-connector-rhel.txt b/source/tutorial/install-bi-connector-rhel.txt
diff --git a/source/tutorial/install-bi-connector-windows.txt b/source/tutorial/install-bi-connector-windows.txt
diff --git a/source/tutorial/kerberos.txt b/source/tutorial/kerberos.txt
diff --git a/source/tutorial/ssl-setup.txt b/source/tutorial/ssl-setup.txt
diff --git a/source/what-is-the-bi-connector.txt b/source/what-is-the-bi-connector.txt
