Skip to content

Commit b5ffc6e

Browse files
DOCSP-41588: Update Sync Settings page with UI changes (#811)
* Update Sync Settings with UI changes * Update screenshots for Migrate page * Update screenshot settings and add ref * Change images to figures * Remove includes * Apply suggestions from code review Co-authored-by: Kyle Rollins <[email protected]> --------- Co-authored-by: Kyle Rollins <[email protected]>
1 parent 3ff17ee commit b5ffc6e

12 files changed

+244
-200
lines changed

snooty.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ name-char-limit = "57"
8383
request-timeout-time = "300 seconds"
8484
sync-default-message-size-limit = "20 MB"
8585
sync-inactive-app-pause-time = "30 days"
86+
sync-min-mongo-version-required = "5.0"
8687
user-session-expiration-time = "30 minutes"
8788
min-user-session-refresh-token-expiration-time = "30 minutes"
8889
max-user-session-refresh-token-expiration-time = "5 years"

source/images/begin-migration.png

87.1 KB
Loading

source/images/cancel-migration.png

112 KB
Loading

source/images/commit-migration.png

16.4 KB
Loading
-19.5 KB
Binary file not shown.

source/images/revert-migration.png

16.3 KB
Loading
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
.. note:: MongoDB Version 5.0 or Higher Required
2-
3-
Atlas Device Sync requires an Atlas cluster running MongoDB version 5.0 or later.
4-
When setting up your cluster, select :guilabel:`MongoDB 5.0` (or a later version)
1+
.. note:: MongoDB Version {+sync-min-mongo-version-required+} or Higher Required
2+
3+
Atlas Device Sync requires an Atlas cluster running MongoDB version {+sync-min-mongo-version-required+} or later.
4+
When setting up your cluster, select the version
55
from the dropdown menu under :guilabel:`Additional Settings`.
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
From the App Services UI, click :guilabel:`Device Sync` in the left
2+
navigation menu. The :guilabel:`Dashboard` tab displays by default.
Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1-
.. note:: Flexible Sync Prerequisites
1+
.. note:: Data Source Requirements for Device Sync
22

3-
Enabling Flexible Sync in Your App Services Application requires a
4-
non-sharded MongoDB Atlas cluster running :manual:`MongoDB 5.0 or greater
5-
</release-notes/>`
3+
To enable Device Sync, your App Services App must have at least one linked
4+
data source that meets the following requirements:
5+
6+
- A non-sharded MongoDB Atlas cluster running
7+
:manual:`MongoDB {+sync-min-mongo-version-required+} or later </release-notes/>`.
8+
- Cluster *cannot* be a serverless instance or {+adf-instance+}. Refer to
9+
:ref:`<data-source-limitations>`.

source/mongodb.txt

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -116,10 +116,7 @@ synced cluster.
116116
To learn more about Atlas Device Sync and how it interacts with your app's data
117117
sources, see :ref:`Atlas Device Sync <sync>`.
118118

119-
.. note:: Version 4.4 Required for Sync
120-
121-
In order to use Atlas Device Sync, your cluster must run MongoDB version
122-
4.4 or newer.
119+
.. include:: /includes/note-flexible-sync-prerequisite.rst
123120

124121
React to Changing Data
125122
~~~~~~~~~~~~~~~~~~~~~~
@@ -154,10 +151,10 @@ You can configure a new linked data source in the App Services UI or by defining
154151
and pushing a configuration file with the {+cli-ref+} or GitHub deployment:
155152

156153
.. tabs-realm-admin-interfaces::
157-
154+
158155
.. tab::
159156
:tabid: ui
160-
157+
161158
.. procedure::
162159

163160
.. step:: Navigate to the Data Source Management Screen
@@ -216,10 +213,10 @@ and pushing a configuration file with the {+cli-ref+} or GitHub deployment:
216213
process of linking to the data source, which could take up to five
217214
minutes.
218215

219-
216+
220217
.. tab::
221218
:tabid: cli
222-
219+
223220
.. procedure::
224221

225222
.. step:: Pull the Latest Version of Your App
@@ -311,6 +308,7 @@ and pushing a configuration file with the {+cli-ref+} or GitHub deployment:
311308

312309
{+cli-bin+} push --remote="<Your App ID>"
313310

311+
.. _data-source-limitations:
314312

315313
Data Source Limitations
316314
-----------------------

0 commit comments

Comments
 (0)