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

Add missing meta descriptions #727

Merged
merged 1 commit into from
Apr 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions source/about-mongosync.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
About ``mongosync``
====================

.. meta::
:description: Explore how `mongosync` facilitates continuous data synchronization and one-time migrations between clusters, including its state transitions and API operations.

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
3 changes: 3 additions & 0 deletions source/connecting.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
Connecting ``mongosync``
========================

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


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

Expand Down
3 changes: 3 additions & 0 deletions source/connecting/atlas-to-atlas.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Connect Two Atlas Clusters
==========================

.. meta::
:description: Connect Atlas clusters using the mongosync utility, which supports replica sets and sharded clusters, requiring MongoDB 6.0 or later.

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
3 changes: 3 additions & 0 deletions source/connecting/onprem-to-atlas.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Connect a Self-Managed Cluster to Atlas
=======================================

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


.. default-domain:: mongodb

Expand Down
3 changes: 3 additions & 0 deletions source/connecting/onprem-to-onprem.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Connect Two Self-Managed Clusters
=================================

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


.. default-domain:: mongodb

Expand Down
3 changes: 3 additions & 0 deletions source/faq.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Frequently Asked Questions
==========================

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


.. default-domain:: mongodb

Expand Down
3 changes: 3 additions & 0 deletions source/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Cluster-to-Cluster Sync
=======================

.. meta::
:description: Enable continuous data synchronization or one-time migration between MongoDB clusters using the mongosync utility.

.. default-domain:: mongodb

{+c2c-product-name+} provides continuous data synchronization or a
Expand Down
3 changes: 3 additions & 0 deletions source/installation.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Installation
============

.. meta::
:description: Find instructions to install Cluster-to-Cluster Sync on Linux and macOS.


.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/installation/install-on-linux.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Install on Linux
================

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


.. default-domain:: mongodb

Expand Down
3 changes: 3 additions & 0 deletions source/installation/install-on-macos.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Install on macOS
================

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


.. default-domain:: mongodb

Expand Down
3 changes: 3 additions & 0 deletions source/quickstart.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
{+c2c-product-name+} Quickstart
==================================

.. meta::
:description: Set up and synchronize data between MongoDB clusters using Cluster-to-Cluster Sync with `mongosync`, including connection setup and data verification.

.. default-domain:: mongodb

.. facet::
Expand Down
3 changes: 3 additions & 0 deletions source/reference.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
Reference
=========

.. meta::
:description: Explore the configuration, API endpoints, and limitations of `mongosync` for cluster synchronization, including authentication and data verification processes.

:ref:`c2c-mongosync`
Overview of ``mongosync`` binary.

Expand Down
3 changes: 3 additions & 0 deletions source/reference/api.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
mongosync API Endpoints
=======================

.. meta::
:description: Explore API endpoints for managing synchronization sessions between source and destination clusters, including starting, pausing, resuming, finalizing, and reversing sync.

.. default-domain:: mongodb

:ref:`c2c-api-start`
Expand Down
3 changes: 3 additions & 0 deletions source/reference/api/commit.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
``commit``
==========

.. meta::
:description: Finalize the sync between clusters using the `commit` endpoint, ensuring data consistency and restoring collection characteristics.

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
3 changes: 3 additions & 0 deletions source/reference/api/pause.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
``pause``
=========

.. meta::
:description: Pause the current synchronization operation using the `pause` endpoint when `mongosync` is in the RUNNING state.


.. default-domain:: mongodb

Expand Down
3 changes: 3 additions & 0 deletions source/reference/api/progress.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
``progress``
============

.. meta::
:description: Retrieve the synchronization status or error details using the `progress` endpoint in the cluster-to-cluster sync API.

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
3 changes: 3 additions & 0 deletions source/reference/api/resume.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
``resume``
==========

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


.. default-domain:: mongodb

Expand Down
3 changes: 3 additions & 0 deletions source/reference/api/reverse.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
``reverse``
===========

.. meta::
:description: Reverse the direction of a committed sync operation between clusters using the `reverse` endpoint, ensuring prerequisites are met.

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
3 changes: 3 additions & 0 deletions source/reference/api/start.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
``start``
=========

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


.. default-domain:: mongodb

Expand Down
3 changes: 3 additions & 0 deletions source/reference/collection-level-filtering.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Filtered Sync
=============

.. meta::
: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.


.. default-domain:: mongodb

Expand Down
3 changes: 3 additions & 0 deletions source/reference/collection-level-filtering/filter-regex.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Regular Expressions in Filters
##############################

.. meta::
:description: Configure filters for `includeNamespaces` and `excludeNamespaces` in Filtered Sync using regular expressions to match databases and collections.

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
3 changes: 3 additions & 0 deletions source/reference/configuration.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Configuration
=============

.. meta::
:description: Configure mongosync instances using command line options or a YAML configuration file, and learn how to reconfigure settings during synchronization.

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
3 changes: 3 additions & 0 deletions source/reference/cutover-process.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Finalize Cutover Process
========================

.. meta::
:description: Finalize a migration and transfer application workload using the mongosync cutover process, ensuring successful data sync and write permissions on the destination cluster.

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
3 changes: 3 additions & 0 deletions source/reference/limitations.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Limitations
===========

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


.. default-domain:: mongodb

Expand Down
3 changes: 3 additions & 0 deletions source/reference/logging.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
Logging
=======

.. meta::
:description: Configure `mongosync` logging to stdout or file, adjust verbosity, and understand log rotation and JSON format for monitoring events.

.. default-domain:: mongodb

:ref:`mongosync <c2c-mongosync>` maintains a running log of events,
Expand Down
3 changes: 3 additions & 0 deletions source/reference/mongosync-states.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
``mongosync`` States
====================

.. meta::
:description: Explore the different states of `mongosync`, which determine the available API operations for managing sync processes between clusters.

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
3 changes: 3 additions & 0 deletions source/reference/mongosync.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
``mongosync``
=============

.. meta::
:description: Use `mongosync` to migrate and continuously sync data between MongoDB clusters, with options for configuration and compatibility considerations.

.. default-domain:: mongodb

.. program:: mongosync
Expand Down
3 changes: 3 additions & 0 deletions source/reference/mongosync/mongosync-behavior.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
``mongosync`` Behavior
======================

.. meta::
:description: Understand how `mongosync` migrates and syncs data between clusters, including its behavior, settings, and considerations for continuous synchronization.

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
3 changes: 3 additions & 0 deletions source/reference/oplog-sizing.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
oplog Sizing
============

.. meta::
:description: Ensure successful data synchronization between clusters by managing oplog size and monitoring replication lag with `mongosync`.

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
3 changes: 3 additions & 0 deletions source/reference/permissions.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
User Permissions
================

.. meta::
: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.

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
3 changes: 3 additions & 0 deletions source/reference/supported-server-version.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
MongoDB Server Version Compatibility
====================================

.. meta::
:description: Understand the MongoDB server version requirements and limitations for using Cluster-to-Cluster Sync, including supported source and destination versions.

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
3 changes: 3 additions & 0 deletions source/reference/telemetry.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Telemetry
=========

.. meta::
:description: Discover how to manage telemetry data collection in `mongosync`, including options to disable it for privacy concerns.

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
3 changes: 3 additions & 0 deletions source/reference/verification.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Verify Data Transfer
====================

.. meta::
:description: Verify data transfer between clusters using methods like embedded verifier, document counts, hash comparison, and custom scripts to ensure successful migration.

.. default-domain:: mongodb

.. facet::
Expand Down
3 changes: 3 additions & 0 deletions source/reference/verification/count.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Verify with Document Counts
===========================

.. meta::
:description: Verify successful sync between clusters by comparing document counts in each synced collection, suitable for insert-only workloads.

.. default-domain:: mongodb

.. facet::
Expand Down
3 changes: 3 additions & 0 deletions source/reference/verification/hash.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Verify with Hash Comparison
===========================

.. meta::
: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.

.. default-domain:: mongodb

.. facet::
Expand Down
3 changes: 3 additions & 0 deletions source/reference/verification/verifier.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Verify with Migration Verifier
==============================

.. meta::
:description: Verify cluster sync success using Migration Verifier, which checks documents, views, and indexes concurrently with `mongosync`.

.. default-domain:: mongodb

.. facet::
Expand Down
3 changes: 3 additions & 0 deletions source/reference/versioning.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
``mongosync`` Versioning
========================

.. meta::
:description: Understand how Cluster-to-Cluster Sync uses semantic versioning, including guidelines for major, minor, and patch version updates.

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
3 changes: 3 additions & 0 deletions source/release-notes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
Release Notes
=============

.. meta::
:description: Explore the release notes for Cluster-to-Cluster Sync, including the latest stable version and previous releases.

Always install the latest, stable version of {+c2c-product-name+}. For
more information on types of MongoDB releases, see
:ref:`c2c-release-version-numbers`.
Expand Down
3 changes: 3 additions & 0 deletions source/release-notes/0.9.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Release Notes for mongosync 0.9
===============================

.. meta::
:description: Explore the release notes for mongosync 0.9, highlighting its preview status and potential limitations.

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
3 changes: 3 additions & 0 deletions source/release-notes/1.0.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Release Notes for mongosync 1.0
===============================

.. meta::
:description: Discover the new features in mongosync 1.0, including support for multiple instances, DDL operations, collation, and API improvements.

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
Loading