From 838b571a7a47de1c4426025372d61e4d571b6eda Mon Sep 17 00:00:00 2001 From: Dachary Date: Mon, 5 Feb 2024 10:44:37 -0500 Subject: [PATCH] (DOCSP-36150): Add callout about ignoring collation (#668) * Add callout about ignoring collation * Add meta descriptions and facet values * Incorporate review feedback Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com> --------- Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com> --- .../includes/important-sync-ignores-custom-collation.rst | 5 +++++ source/rules/sync-compatibility.txt | 9 +++++++++ source/sync/get-started.txt | 9 +++++++++ 3 files changed, 23 insertions(+) create mode 100644 source/includes/important-sync-ignores-custom-collation.rst diff --git a/source/includes/important-sync-ignores-custom-collation.rst b/source/includes/important-sync-ignores-custom-collation.rst new file mode 100644 index 000000000..6a4b622a4 --- /dev/null +++ b/source/includes/important-sync-ignores-custom-collation.rst @@ -0,0 +1,5 @@ +.. important:: Flexible Sync Ignores Custom Collation + + Flexible Sync ignores any custom :ref:`collation` that you may have configured on + a MongoDB collection in Atlas. Instead, Synced collections always use + ``{locale: "simple"}`` when evaluating Sync subscriptions or permissions. diff --git a/source/rules/sync-compatibility.txt b/source/rules/sync-compatibility.txt index e0653778c..132314b34 100644 --- a/source/rules/sync-compatibility.txt +++ b/source/rules/sync-compatibility.txt @@ -4,6 +4,13 @@ Device Sync-Compatible Permissions ================================== +.. meta:: + :description: Device Sync has special considerations when using the permissions system. + +.. facet:: + :name: genre + :values: reference + .. contents:: On this page :local: :backlinks: none @@ -16,6 +23,8 @@ considerations when using the permissions system. For a guide to setting up Flexible Sync with common permissions models, see the :ref:`flexible-sync-permissions-guide`. +.. include:: /includes/important-sync-ignores-custom-collation.rst + .. _sync-compatible-roles: Sync-Compatible Roles diff --git a/source/sync/get-started.txt b/source/sync/get-started.txt index 206b3b61d..53fb8cbe5 100644 --- a/source/sync/get-started.txt +++ b/source/sync/get-started.txt @@ -4,6 +4,13 @@ Get Started with Atlas Device Sync ================================== +.. meta:: + :description: Learn how to get started with Atlas Device Sync in this high-level overview. + +.. facet:: + :name: genre + :values: reference + .. contents:: On this page :local: :backlinks: none @@ -176,3 +183,5 @@ To create queries from your client application, refer to the Realm SDK documenta - :ref:`Flexible Sync - Node.js SDK ` - :ref:`Flexible Sync - React Native SDK ` - :ref:`Flexible Sync - Swift SDK ` + +.. include:: /includes/important-sync-ignores-custom-collation.rst