Skip to content
This repository was archived by the owner on May 1, 2025. It is now read-only.

Commit 3246028

Browse files
authored
Add missing meta descriptions (#727)
1 parent 06b6217 commit 3246028

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+153
-0
lines changed

source/about-mongosync.txt

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

7+
.. meta::
8+
:description: Explore how `mongosync` facilitates continuous data synchronization and one-time migrations between clusters, including its state transitions and API operations.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

source/connecting.txt

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

8+
.. meta::
9+
:description: Connect MongoDB clusters using the mongosync utility for self-managed, Atlas, or mixed environments.
10+
811

912
.. include:: /includes/fact-connect-intro
1013

source/connecting/atlas-to-atlas.txt

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

7+
.. meta::
8+
:description: Connect Atlas clusters using the mongosync utility, which supports replica sets and sharded clusters, requiring MongoDB 6.0 or later.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

source/connecting/onprem-to-atlas.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Connect a Self-Managed Cluster to Atlas
55
=======================================
66

7+
.. meta::
8+
:description: Connect a self-managed MongoDB cluster to an Atlas cluster using the mongosync utility, detailing connection strings, authentication, and required permissions.
9+
710

811
.. default-domain:: mongodb
912

source/connecting/onprem-to-onprem.txt

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

7+
.. meta::
8+
:description: Connect self-managed MongoDB clusters using the mongosync utility, which requires specific permissions and connection strings for synchronization.
9+
710

811
.. default-domain:: mongodb
912

source/faq.txt

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

7+
.. meta::
8+
:description: Find answers to common questions about using `mongosync` for cluster-to-cluster synchronization, including handling errors and hardware requirements.
9+
710

811
.. default-domain:: mongodb
912

source/index.txt

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

7+
.. meta::
8+
:description: Enable continuous data synchronization or one-time migration between MongoDB clusters using the mongosync utility.
9+
710
.. default-domain:: mongodb
811

912
{+c2c-product-name+} provides continuous data synchronization or a

source/installation.txt

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

7+
.. meta::
8+
:description: Find instructions to install Cluster-to-Cluster Sync on Linux and macOS.
9+
710

811
.. contents:: On this page
912
:local:

source/installation/install-on-linux.txt

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

7+
.. meta::
8+
:description: Install Cluster-to-Cluster Sync on Linux by downloading and extracting the `mongosync` tarball, then adding the binary to your `PATH`.
9+
710

811
.. default-domain:: mongodb
912

source/installation/install-on-macos.txt

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

7+
.. meta::
8+
:description: Install the latest version of `mongosync` on macOS by downloading and unzipping the ZIP file, then adding the binary to your `PATH`.
9+
710

811
.. default-domain:: mongodb
912

source/quickstart.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
{+c2c-product-name+} Quickstart
55
==================================
66

7+
.. meta::
8+
:description: Set up and synchronize data between MongoDB clusters using Cluster-to-Cluster Sync with `mongosync`, including connection setup and data verification.
9+
710
.. default-domain:: mongodb
811

912
.. facet::

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 configuration, API endpoints, and limitations of `mongosync` for cluster synchronization, including authentication and data verification processes.
7+
58
:ref:`c2c-mongosync`
69
Overview of ``mongosync`` binary.
710

source/reference/api.txt

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

7+
.. meta::
8+
:description: Explore API endpoints for managing synchronization sessions between source and destination clusters, including starting, pausing, resuming, finalizing, and reversing sync.
9+
710
.. default-domain:: mongodb
811

912
:ref:`c2c-api-start`

source/reference/api/commit.txt

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

7+
.. meta::
8+
:description: Finalize the sync between clusters using the `commit` endpoint, ensuring data consistency and restoring collection characteristics.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

source/reference/api/pause.txt

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

7+
.. meta::
8+
:description: Pause the current synchronization operation using the `pause` endpoint when `mongosync` is in the RUNNING state.
9+
710

811
.. default-domain:: mongodb
912

source/reference/api/progress.txt

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

7+
.. meta::
8+
:description: Retrieve the synchronization status or error details using the `progress` endpoint in the cluster-to-cluster sync API.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

source/reference/api/resume.txt

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

7+
.. meta::
8+
:description: Resume a paused synchronization session using the `resume` endpoint, requiring `mongosync` to be in the PAUSED state.
9+
710

811
.. default-domain:: mongodb
912

source/reference/api/reverse.txt

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

7+
.. meta::
8+
:description: Reverse the direction of a committed sync operation between clusters using the `reverse` endpoint, ensuring prerequisites are met.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

source/reference/api/start.txt

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

7+
.. meta::
8+
:description: Initiate synchronization between source and destination clusters using the `start` endpoint, with options for index building, write blocking, and namespace filtering.
9+
710

811
.. default-domain:: mongodb
912

source/reference/collection-level-filtering.txt

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

7+
.. meta::
8+
:description: Configure filtered sync in Cluster-to-Cluster Sync to specify which databases and collections to transfer between MongoDB clusters using inclusion and exclusion filters.
9+
710

811
.. default-domain:: mongodb
912

source/reference/collection-level-filtering/filter-regex.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Regular Expressions in Filters
55
##############################
66

7+
.. meta::
8+
:description: Configure filters for `includeNamespaces` and `excludeNamespaces` in Filtered Sync using regular expressions to match databases and collections.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

source/reference/configuration.txt

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

7+
.. meta::
8+
:description: Configure mongosync instances using command line options or a YAML configuration file, and learn how to reconfigure settings during synchronization.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

source/reference/cutover-process.txt

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

7+
.. meta::
8+
:description: Finalize a migration and transfer application workload using the mongosync cutover process, ensuring successful data sync and write permissions on the destination cluster.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

source/reference/limitations.txt

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

7+
.. meta::
8+
:description: Understand the limitations of using `mongosync` for cluster-to-cluster sync, including unsupported features, required configurations, and specific conditions for successful migration.
9+
710

811
.. default-domain:: mongodb
912

source/reference/logging.txt

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

8+
.. meta::
9+
:description: Configure `mongosync` logging to stdout or file, adjust verbosity, and understand log rotation and JSON format for monitoring events.
10+
811
.. default-domain:: mongodb
912

1013
:ref:`mongosync <c2c-mongosync>` maintains a running log of events,

source/reference/mongosync-states.txt

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

7+
.. meta::
8+
:description: Explore the different states of `mongosync`, which determine the available API operations for managing sync processes between clusters.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

source/reference/mongosync.txt

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

7+
.. meta::
8+
:description: Use `mongosync` to migrate and continuously sync data between MongoDB clusters, with options for configuration and compatibility considerations.
9+
710
.. default-domain:: mongodb
811

912
.. program:: mongosync

source/reference/mongosync/mongosync-behavior.txt

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

7+
.. meta::
8+
:description: Understand how `mongosync` migrates and syncs data between clusters, including its behavior, settings, and considerations for continuous synchronization.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

source/reference/oplog-sizing.txt

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

7+
.. meta::
8+
:description: Ensure successful data synchronization between clusters by managing oplog size and monitoring replication lag with `mongosync`.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

source/reference/permissions.txt

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

7+
.. meta::
8+
:description: Ensure the user in the `mongosync` connection string has the necessary permissions on source and destination clusters for various sync types in self-managed and Atlas environments.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

source/reference/supported-server-version.txt

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

7+
.. meta::
8+
:description: Understand the MongoDB server version requirements and limitations for using Cluster-to-Cluster Sync, including supported source and destination versions.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

source/reference/telemetry.txt

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

7+
.. meta::
8+
:description: Discover how to manage telemetry data collection in `mongosync`, including options to disable it for privacy concerns.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

source/reference/verification.txt

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

7+
.. meta::
8+
:description: Verify data transfer between clusters using methods like embedded verifier, document counts, hash comparison, and custom scripts to ensure successful migration.
9+
710
.. default-domain:: mongodb
811

912
.. facet::

source/reference/verification/count.txt

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

7+
.. meta::
8+
:description: Verify successful sync between clusters by comparing document counts in each synced collection, suitable for insert-only workloads.
9+
710
.. default-domain:: mongodb
811

912
.. facet::

source/reference/verification/hash.txt

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

7+
.. meta::
8+
:description: Verify sync between clusters by comparing MD5 hashes of collections, noting that this method locks the cluster and is slower than document count verification.
9+
710
.. default-domain:: mongodb
811

912
.. facet::

source/reference/verification/verifier.txt

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

7+
.. meta::
8+
:description: Verify cluster sync success using Migration Verifier, which checks documents, views, and indexes concurrently with `mongosync`.
9+
710
.. default-domain:: mongodb
811

912
.. facet::

source/reference/versioning.txt

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

7+
.. meta::
8+
:description: Understand how Cluster-to-Cluster Sync uses semantic versioning, including guidelines for major, minor, and patch version updates.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

source/release-notes.txt

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

5+
.. meta::
6+
:description: Explore the release notes for Cluster-to-Cluster Sync, including the latest stable version and previous releases.
7+
58
Always install the latest, stable version of {+c2c-product-name+}. For
69
more information on types of MongoDB releases, see
710
:ref:`c2c-release-version-numbers`.

source/release-notes/0.9.txt

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

7+
.. meta::
8+
:description: Explore the release notes for mongosync 0.9, highlighting its preview status and potential limitations.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

source/release-notes/1.0.txt

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

7+
.. meta::
8+
:description: Discover the new features in mongosync 1.0, including support for multiple instances, DDL operations, collation, and API improvements.
9+
710
.. default-domain:: mongodb
811

912
.. contents:: On this page

0 commit comments

Comments
 (0)