From e7666fd9af6ca1ffc17860e890c66bac28b66563 Mon Sep 17 00:00:00 2001 From: MongoCaleb <32645888+MongoCaleb@users.noreply.github.com> Date: Tue, 1 Oct 2024 15:17:49 -0700 Subject: [PATCH] remove mentions of Edge Server (#3382) ## Pull Request Info - SDK Docs Consolidation Jira ticket: https://jira.mongodb.org/browse/DOCSP-43675 ### Staging Links
  • index
  • sdk/dotnet/app-services/connect-to-app-services-backend
  • sdk/flutter/app-services/connect-to-app
  • sdk/kotlin/app-services/connect-to-app-services-backend
  • sdk/kotlin/realm-database/crud/read
  • sdk/kotlin/realm-database/open-and-close-a-realm
  • sdk/node/app-services/connect-to-app-services-backend
  • sdk/node/model-data/data-types/counters
  • sdk/react-native/app-services/connect-to-app-services-app
  • sdk/swift/app-services/connect-to-app-services-backend
  • sdk/swift/realm-files
  • studio/view-atlas-data-sync
    • --- examples/dart/test/app_services_test.dart | 4 ++-- ...app_services_test.snippet.change-base-url.dart | 4 ++-- source/index.txt | 4 ++-- .../connect-to-app-services-backend.txt | 4 +--- .../sdk/flutter/app-services/connect-to-app.txt | 8 +++----- .../connect-to-app-services-backend.txt | 15 +++------------ source/sdk/kotlin/realm-database/crud/read.txt | 3 ++- .../realm-database/open-and-close-a-realm.txt | 3 ++- .../connect-to-app-services-backend.txt | 4 +--- .../sdk/node/model-data/data-types/counters.txt | 3 ++- .../app-services/connect-to-app-services-app.txt | 4 +--- .../connect-to-app-services-backend.txt | 4 +--- source/sdk/swift/realm-files.txt | 2 +- source/studio/view-atlas-data-sync.txt | 2 +- 14 files changed, 24 insertions(+), 40 deletions(-) diff --git a/examples/dart/test/app_services_test.dart b/examples/dart/test/app_services_test.dart index 2765f7e07f..0df8357871 100644 --- a/examples/dart/test/app_services_test.dart +++ b/examples/dart/test/app_services_test.dart @@ -47,8 +47,8 @@ void main() { test('Change BaseUrl', () async { // :snippet-start: change-base-url // Specify a custom baseUrl to connect to. - // In this case, an Edge Server instance running on the device. - final appConfig = AppConfiguration(edgeServerAppId, + // In this case, a custom server instance running on the device. + final appConfig = AppConfiguration(customServerAppId, baseUrl: Uri.parse('http://localhost:80')); var app = App(appConfig); diff --git a/source/examples/generated/flutter/app_services_test.snippet.change-base-url.dart b/source/examples/generated/flutter/app_services_test.snippet.change-base-url.dart index a4cbca41bf..5cf00e0a16 100644 --- a/source/examples/generated/flutter/app_services_test.snippet.change-base-url.dart +++ b/source/examples/generated/flutter/app_services_test.snippet.change-base-url.dart @@ -1,6 +1,6 @@ // Specify a custom baseUrl to connect to. -// In this case, an Edge Server instance running on the device. -final appConfig = AppConfiguration(edgeServerAppId, +// In this case, a custom server instance running on the device. +final appConfig = AppConfiguration(customServerAppId, baseUrl: Uri.parse('http://localhost:80')); var app = App(appConfig); diff --git a/source/index.txt b/source/index.txt index 982f862d4e..b16379177d 100644 --- a/source/index.txt +++ b/source/index.txt @@ -35,8 +35,8 @@ Welcome to the Atlas Device SDK Docs .. introduction:: Atlas Device SDK is a suite of app development tools optimized for - data access and persistence on mobile and edge devices. Use the SDKs to - build data-driven mobile, edge, web, desktop, and IoT apps. + data access and persistence on mobile devices. Use the SDKs to + build data-driven mobile, web, desktop, and IoT apps. .. button:: Get started with a tutorial :uri: https://mongodb.com/docs/atlas/app-services/get-started/ diff --git a/source/sdk/dotnet/app-services/connect-to-app-services-backend.txt b/source/sdk/dotnet/app-services/connect-to-app-services-backend.txt index 46003b0c83..4f81bfd9f2 100644 --- a/source/sdk/dotnet/app-services/connect-to-app-services-backend.txt +++ b/source/sdk/dotnet/app-services/connect-to-app-services-backend.txt @@ -62,7 +62,6 @@ connect to a different server: - Your App Services App uses :ref:`local deployment `, and you want to connect directly to a local ``baseURL`` in your region. -- You want to connect to an :ref:`Edge Server instance `. You can specify a ``baseURL`` in the :dotnet-sdk:`AppConfiguration `. @@ -76,8 +75,7 @@ Connect to a Different Server During Runtime .. versionadded:: 12.1.0 In some cases, you might want to change the ``baseURL`` while the app is -running. For example, you might want to roam between Edge Servers, or -move from an App Services connection to an Edge Server connection. To change +running. To change the ``baseURL`` during runtime, call the :dotnet-sdk:`app.UpdateBaseUriAsync() ` method: diff --git a/source/sdk/flutter/app-services/connect-to-app.txt b/source/sdk/flutter/app-services/connect-to-app.txt index a744e181ec..e07b8ff6f3 100644 --- a/source/sdk/flutter/app-services/connect-to-app.txt +++ b/source/sdk/flutter/app-services/connect-to-app.txt @@ -127,9 +127,8 @@ By default, Atlas Device SDK connects to Atlas using the global ``baseUrl`` of ``https://services.cloud.mongodb.com``. In some cases, you may want to connect to a different server: -- Your App Services App uses local deployment, and you want to connect directly to a local ``baseUrl`` in your region. For more information, refer to the :ref:`` App Services documentation. -- You want to connect to an Edge Server instance. For more information, refer to - the :ref:`edge-server-connect-from-client` App Services documentation. +- Your App Services App uses local deployment, and you want to connect directly to a local ``baseUrl`` in your region. +For more information, refer to the :ref:`` App Services documentation. You can specify a ``baseUrl`` in the :flutter-sdk:`AppConfiguration `: @@ -145,8 +144,7 @@ Connect to a Different Server During Runtime ``updateBaseUrl`` accepts ``null`` value In some cases, you might want to change the ``baseUrl`` while the app is -running. For example, you might want to roam between Edge Servers or -move from an App Services connection to an Edge Server connection. +running. To change the ``baseUrl`` during runtime, call the experimental :flutter-sdk:`app.updateBaseUrl ` method. You can diff --git a/source/sdk/kotlin/app-services/connect-to-app-services-backend.txt b/source/sdk/kotlin/app-services/connect-to-app-services-backend.txt index 2534f1cb13..c0389497f0 100644 --- a/source/sdk/kotlin/app-services/connect-to-app-services-backend.txt +++ b/source/sdk/kotlin/app-services/connect-to-app-services-backend.txt @@ -270,9 +270,8 @@ By default, Atlas Device SDK connects to Atlas using the global ``baseUrl`` of ``https://services.cloud.mongodb.com``. In some cases, you may want to connect to a different server: -- Your App Services App uses local deployment, and you want to connect directly to a local ``baseUrl`` in your region. For more information, refer to the :ref:`` App Services documentation. -- You want to connect to an Edge Server instance. For more information, refer to - the :ref:`edge-server-connect-from-client` App Services documentation. +- Your App Services App uses local deployment, and you want to connect directly to a local ``baseUrl`` in your region. +For more information, refer to the :ref:`` App Services documentation. You can specify a ``baseUrl`` in the `AppConfiguration <{+kotlin-sync-prefix+}io.realm.kotlin.mongodb/-app-configuration/index.html>`__: @@ -286,8 +285,7 @@ Connect to a Different Server During Runtime .. versionadded:: 1.16.0 In some cases, you might want to change the ``baseUrl`` while the app is -running. For example, you might want to roam between Edge Servers or -move from an App Services connection to an Edge Server connection. +running. To change the ``baseUrl`` during runtime, call the experimental `app.updateBaseUrl <{+kotlin-sync-prefix+}io.realm.kotlin.mongodb/-app/index.html#2007791704%2FFunctions%2F380376748>`__ method. You can @@ -296,13 +294,6 @@ pass ``null`` to reset the ``baseUrl`` to the default value. .. literalinclude:: /examples/generated/kotlin/AppClientTest.snippet.change-base-url.kt :language: kotlin -This API is experimental and requires the `@ExperimentalEdgeServerApi -<{+kotlin-sync-prefix+}io.realm.kotlin.mongodb.annotations/-experimental-edge-server-api/index.html>`__ -annotation: - -.. literalinclude:: /examples/generated/kotlin/AppClientTest.snippet.experimental-opt-in.kt - :language: kotlin - If you change the ``baseUrl`` *after* you have logged in a user and have opened a synced database, the app must perform a client reset. For more information, refer to :ref:`kotlin-client-reset`. diff --git a/source/sdk/kotlin/realm-database/crud/read.txt b/source/sdk/kotlin/realm-database/crud/read.txt index f0898524e5..5715ca576a 100644 --- a/source/sdk/kotlin/realm-database/crud/read.txt +++ b/source/sdk/kotlin/realm-database/crud/read.txt @@ -279,7 +279,8 @@ notation. To filter by property, you can pass Realm Query Language (RQL) filters and operators, use Kotlin's built-in extension methods or the SDK's convenience methods, or use a combination. For information on all currently supported RQL -operators and syntax, refer to the :ref:`` reference documentation. +operators and syntax, refer to the :ref:`Realm Query Language ` reference +documentation. In the following example, we query a ``Frog`` object type and filter by the ``name`` property: diff --git a/source/sdk/kotlin/realm-database/open-and-close-a-realm.txt b/source/sdk/kotlin/realm-database/open-and-close-a-realm.txt index 746c48a007..adca845bd2 100644 --- a/source/sdk/kotlin/realm-database/open-and-close-a-realm.txt +++ b/source/sdk/kotlin/realm-database/open-and-close-a-realm.txt @@ -46,7 +46,8 @@ path, which you can define when you open the realm. .. tip:: Work with Realm Files in Realm Studio - You can open, view, and edit the contents of realm files with :ref:`realm-studio`. + You can open, view, and edit the contents of realm files with + :ref:`Realm Studio `. If you don't want to create a ``.realm`` file or its associated auxiliary files, you can open an in-memory realm. diff --git a/source/sdk/node/app-services/connect-to-app-services-backend.txt b/source/sdk/node/app-services/connect-to-app-services-backend.txt index 08adb68f4f..3b68d9f8d7 100644 --- a/source/sdk/node/app-services/connect-to-app-services-backend.txt +++ b/source/sdk/node/app-services/connect-to-app-services-backend.txt @@ -149,7 +149,6 @@ connect to a different server: - Your App Services App uses :ref:`local deployment `, and you want to connect directly to a local ``baseURL`` in your region. -- You want to connect to an :ref:`Edge Server instance `. You can specify a ``baseURL`` in the :js-sdk:`AppConfiguration `: @@ -176,8 +175,7 @@ Connect to a Different Server During Runtime .. versionadded:: 12.8.0 In some cases, you might want to change the ``baseURL`` while the app is -running. For example, you might want to roam between Edge Servers, or -move from an App Services connection to an Edge Server connection. +running. To change the ``baseURL`` during runtime, call the ``app.updateBaseUrl()`` method. Note that the string value can't end in a trailing slash. diff --git a/source/sdk/node/model-data/data-types/counters.txt b/source/sdk/node/model-data/data-types/counters.txt index 171297d57d..ff157f9811 100644 --- a/source/sdk/node/model-data/data-types/counters.txt +++ b/source/sdk/node/model-data/data-types/counters.txt @@ -130,4 +130,5 @@ counter value greater than or equal to that of the specified counter. .. include:: /examples/generated/node/v12/formatted/data-types.test.snippet.filtering-with-counter.ts.rst -For more information on querying with the SDK, refer to :ref:`realm-query-language`. +For more information on querying with the SDK, refer to +:ref:`Realm Query Language `. diff --git a/source/sdk/react-native/app-services/connect-to-app-services-app.txt b/source/sdk/react-native/app-services/connect-to-app-services-app.txt index 47c621c401..cae1eccec8 100644 --- a/source/sdk/react-native/app-services/connect-to-app-services-app.txt +++ b/source/sdk/react-native/app-services/connect-to-app-services-app.txt @@ -106,7 +106,6 @@ connect to a different server: - Your App Services App uses :ref:`local deployment `, and you want to connect directly to a local ``baseURL`` in your region. -- You want to connect to an :ref:`Edge Server instance `. You can specify a ``baseURL`` as a prop for :ref:`AppProvider `. All :js-sdk:`AppConfiguration ` keys can be @@ -118,8 +117,7 @@ Connect to a Different Server During Runtime .. versionchanged:: ``realm@12.8.0`` In some cases, you might want to change the ``baseURL`` while the app is -running. For example, you might want to roam between Edge Servers, or -move from an App Services connection to an Edge Server connection. +running. Currently, this feature is implemented as an experimental module that requires specific TypeScript configuration. The required configuration can be difficult diff --git a/source/sdk/swift/app-services/connect-to-app-services-backend.txt b/source/sdk/swift/app-services/connect-to-app-services-backend.txt index 93e1115523..a09b410b02 100644 --- a/source/sdk/swift/app-services/connect-to-app-services-backend.txt +++ b/source/sdk/swift/app-services/connect-to-app-services-backend.txt @@ -115,7 +115,6 @@ connect to a different server: - Your App Services App uses :ref:`local deployment `, and you want to connect directly to a local ``baseURL`` in your region. -- You want to connect to an :ref:`Edge Server instance `. You can specify a ``baseURL`` in the :swift-sdk:`AppConfiguration `: @@ -129,8 +128,7 @@ Connect to a Different Server During Runtime .. versionadded:: 10.50.0 In some cases, you might want to change the ``baseURL`` while the app is -running. For example, you might want to roam between Edge Servers, or -move from an App Services connection to an Edge Server connection. To change +running. To change the ``baseURL`` during runtime, call the ``app.updateBaseUrl(to: )`` method: .. literalinclude:: /examples/generated/code/start/RealmApp.snippet.change-base-url.swift diff --git a/source/sdk/swift/realm-files.txt b/source/sdk/swift/realm-files.txt index df201ea9b1..96303e73b0 100644 --- a/source/sdk/swift/realm-files.txt +++ b/source/sdk/swift/realm-files.txt @@ -38,7 +38,7 @@ Realm stores a binary encoded version of every object and type in a realm in a single ``.realm`` file. The file is located at :ref:`a specific path ` that you can define when you open the realm. You can open, view, and edit the contents of these files with -:ref:`realm-studio`. +:ref:`Realm Studio `. .. _ios-in-memory-realm: diff --git a/source/studio/view-atlas-data-sync.txt b/source/studio/view-atlas-data-sync.txt index 53eac775b5..d23c1b4efc 100644 --- a/source/studio/view-atlas-data-sync.txt +++ b/source/studio/view-atlas-data-sync.txt @@ -142,7 +142,7 @@ Add a Subscription :ref:`queryable-fields` in the App Services documentation. For information about available query operators, refer to the - :ref:`realm-query-language` reference. + :ref:`Realm Query Language ` reference. Device Sync supports using a subset of RQL operators in Sync subscription queries. For information on these limitations, refer to