From 6b579c7e14d76fcba9b35caa21f320c030e35687 Mon Sep 17 00:00:00 2001 From: Dachary Carey Date: Fri, 2 Feb 2024 17:05:06 -0500 Subject: [PATCH 1/3] Add callout about ignoring collation --- source/includes/important-sync-ignores-custom-collation.rst | 5 +++++ source/rules/sync-compatibility.txt | 2 ++ source/sync/get-started.txt | 2 ++ 3 files changed, 9 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..3070bc0d1 --- /dev/null +++ b/source/includes/important-sync-ignores-custom-collation.rst @@ -0,0 +1,5 @@ +.. important:: Flexible Sync Ignores Custom Collation + + Flexible Sync ignores custom :ref:`collation` 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..8e3a5b460 100644 --- a/source/rules/sync-compatibility.txt +++ b/source/rules/sync-compatibility.txt @@ -16,6 +16,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..cee4a8220 100644 --- a/source/sync/get-started.txt +++ b/source/sync/get-started.txt @@ -176,3 +176,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 From 9025ae226bb45b6bd827822af0e1d499a1a23ce5 Mon Sep 17 00:00:00 2001 From: Dachary Carey Date: Fri, 2 Feb 2024 17:15:37 -0500 Subject: [PATCH 2/3] Add meta descriptions and facet values --- source/rules/sync-compatibility.txt | 7 +++++++ source/sync/get-started.txt | 7 +++++++ 2 files changed, 14 insertions(+) diff --git a/source/rules/sync-compatibility.txt b/source/rules/sync-compatibility.txt index 8e3a5b460..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 diff --git a/source/sync/get-started.txt b/source/sync/get-started.txt index cee4a8220..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 From 0f0b2d6f00a56e641cfe1ff54d7735c26a33b66a Mon Sep 17 00:00:00 2001 From: Dachary Date: Mon, 5 Feb 2024 10:36:33 -0500 Subject: [PATCH 3/3] Incorporate review feedback Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com> --- source/includes/important-sync-ignores-custom-collation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/includes/important-sync-ignores-custom-collation.rst b/source/includes/important-sync-ignores-custom-collation.rst index 3070bc0d1..6a4b622a4 100644 --- a/source/includes/important-sync-ignores-custom-collation.rst +++ b/source/includes/important-sync-ignores-custom-collation.rst @@ -1,5 +1,5 @@ .. important:: Flexible Sync Ignores Custom Collation - Flexible Sync ignores custom :ref:`collation` you may have configured on + 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.