diff --git a/.github/workflows/add-netlify-links.yml b/.github/workflows/add-netlify-links.yml index 0b4dfd2e8..6b359736e 100644 --- a/.github/workflows/add-netlify-links.yml +++ b/.github/workflows/add-netlify-links.yml @@ -23,7 +23,7 @@ jobs: id: build_page_links run: | new_links="" - base_link='https://deploy-preview-${{ github.event.number }}--app-services.netlify.app' + base_link='https://deploy-preview-${{ github.event.number }}--docs-app-services.netlify.app' changed_files=${{ steps.changed-files.outputs.all_changed_files }} files=$(echo $changed_files | tr "," "\n") for file in $files; do diff --git a/snooty.toml b/snooty.toml index 3859abeb3..102bfede7 100644 --- a/snooty.toml +++ b/snooty.toml @@ -28,6 +28,7 @@ toc_landing_pages = [ "/services/twilio", "/sync", "/sync/get-started", + "/sync/device-sync-deprecation", "/hosting", "/users", "/values-and-secrets", diff --git a/source/sync/device-sync-deprecation.txt b/source/sync/device-sync-deprecation.txt index 82b97211e..817a31d11 100644 --- a/source/sync/device-sync-deprecation.txt +++ b/source/sync/device-sync-deprecation.txt @@ -14,10 +14,10 @@ Device Sync Deprecation Migrate to AWS AppSync Migrate a React Native Application from Device Sync to PowerSync -As of September 2024, Device Sync is deprecated for Atlas App Services. Device -Sync will reach end-of-life and be removed on **September 30, 2025**. If you -use Device Sync, you should migrate to alternative solution providers before -Device Sync is removed. +As of September 2024, Device Sync is deprecated for Atlas App Services. Device +Sync will reach end-of-life and be removed on **September 30, 2025**. If you +use Device Sync, you should migrate to one of the alternative solution providers +listed below. Refer to the :ref:`App Services deprecation page ` for more deprecation information. @@ -64,8 +64,10 @@ AWS AppSync AWS AppSync creates serverless Pub/Sub APIs to simplify development through a single endpoint to securely query, update, or publish data. -Refer to the `AWS AppSync documentation `__ to -learn more. +For more information on migration, refer to the following: + +- :ref:`Migrate to AWS AppSync ` +- `AWS AppSync documentation `__ HiveMQ ~~~~~~ @@ -96,7 +98,7 @@ Parse is an open source backend server with APIs you can use to easily connect to MongoDB Atlas as the backing database. They also provide client guides for many development platforms. -- `Parse documentation `__ +For more information, refer to the `Parse documentation `__. Custom Solution ~~~~~~~~~~~~~~~ diff --git a/source/sync/migration/awsappsync.txt b/source/sync/migration/awsappsync.txt index 9310135c8..46961a9a0 100644 --- a/source/sync/migration/awsappsync.txt +++ b/source/sync/migration/awsappsync.txt @@ -36,9 +36,9 @@ The following diagram shows the typical Device Sync architecture: .. image:: /images/migration/device_sync_architecture.png :alt: A diagram showing a typical Device Sync architecture. -In this architecture, your app uses the Realm APIs to communicate directly with -Atlas App Services, which handles data storage, synchronization, and conflict -resolution. +In this architecture, your app uses the Atlas Device Sync APIs to communicate +directly with Atlas App Services, which handles data storage, synchronization, +and conflict resolution. The data flow is: @@ -47,7 +47,7 @@ The data flow is: - Device Sync APIs send changes to Atlas App Services. - Atlas App Services performs any necessary conflict resolution, stores the changes in Atlas, and syncs the changes to the other devices. -- Device Sync APIs updates the data in each device’s local realm. +- Device Sync APIs update the data in each device’s local realm. AWS AppServices ~~~~~~~~~~~~~~~ @@ -60,11 +60,11 @@ following changes to your architecture: - Use AWS Event Bridge to listen for event triggers from Atlas - Add a Database Trigger to Atlas -You will also change 2 parts of your client code: +You also need to change the following in your client code: -- Because AppSync uses GraphQL, you will use the AWS AppSync API to communicate - with it AppSync -- The local data store also changes from a Realm database to the default +- Because AppSync uses GraphQL, you need to use AWS AppSync APIs to access + GraphQL endpoints from your application. +- Change the local datastore from a Realm database to the default datastore on the device (typically SQLite), or another one of your choice. The following diagram shows a typical example of the new architecture: