Skip to content

Commit

Permalink
(DOCSP-36150): Add callout about ignoring collation (mongodb#668)
Browse files Browse the repository at this point in the history
* Add callout about ignoring collation

* Add meta descriptions and facet values

* Incorporate review feedback

Co-authored-by: cbullinger <[email protected]>

---------

Co-authored-by: cbullinger <[email protected]>
  • Loading branch information
2 people authored and MongoCaleb committed Jun 3, 2024
1 parent fe2b160 commit 838b571
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 0 deletions.
5 changes: 5 additions & 0 deletions source/includes/important-sync-ignores-custom-collation.rst
Original file line number Diff line number Diff line change
@@ -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.
9 changes: 9 additions & 0 deletions source/rules/sync-compatibility.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
9 changes: 9 additions & 0 deletions source/sync/get-started.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -176,3 +183,5 @@ To create queries from your client application, refer to the Realm SDK documenta
- :ref:`Flexible Sync - Node.js SDK <node-flexible-sync>`
- :ref:`Flexible Sync - React Native SDK <react-native-flexible-sync>`
- :ref:`Flexible Sync - Swift SDK <ios-flexible-sync>`

.. include:: /includes/important-sync-ignores-custom-collation.rst

0 comments on commit 838b571

Please sign in to comment.