Skip to content

Commit

Permalink
remove mentions of Edge Server (#3382)
Browse files Browse the repository at this point in the history
## Pull Request Info - SDK Docs Consolidation

Jira ticket: https://jira.mongodb.org/browse/DOCSP-43675

### Staging Links
<!-- start insert-links -->
<li><a
href=https://deploy-preview-3382--device-sdk.netlify.app/index>index</a></li><li><a
href=https://deploy-preview-3382--device-sdk.netlify.app/sdk/dotnet/app-services/connect-to-app-services-backend>sdk/dotnet/app-services/connect-to-app-services-backend</a></li><li><a
href=https://deploy-preview-3382--device-sdk.netlify.app/sdk/flutter/app-services/connect-to-app>sdk/flutter/app-services/connect-to-app</a></li><li><a
href=https://deploy-preview-3382--device-sdk.netlify.app/sdk/kotlin/app-services/connect-to-app-services-backend>sdk/kotlin/app-services/connect-to-app-services-backend</a></li><li><a
href=https://deploy-preview-3382--device-sdk.netlify.app/sdk/kotlin/realm-database/crud/read>sdk/kotlin/realm-database/crud/read</a></li><li><a
href=https://deploy-preview-3382--device-sdk.netlify.app/sdk/kotlin/realm-database/open-and-close-a-realm>sdk/kotlin/realm-database/open-and-close-a-realm</a></li><li><a
href=https://deploy-preview-3382--device-sdk.netlify.app/sdk/node/app-services/connect-to-app-services-backend>sdk/node/app-services/connect-to-app-services-backend</a></li><li><a
href=https://deploy-preview-3382--device-sdk.netlify.app/sdk/node/model-data/data-types/counters>sdk/node/model-data/data-types/counters</a></li><li><a
href=https://deploy-preview-3382--device-sdk.netlify.app/sdk/react-native/app-services/connect-to-app-services-app>sdk/react-native/app-services/connect-to-app-services-app</a></li><li><a
href=https://deploy-preview-3382--device-sdk.netlify.app/sdk/swift/app-services/connect-to-app-services-backend>sdk/swift/app-services/connect-to-app-services-backend</a></li><li><a
href=https://deploy-preview-3382--device-sdk.netlify.app/sdk/swift/realm-files>sdk/swift/realm-files</a></li><li><a
href=https://deploy-preview-3382--device-sdk.netlify.app/studio/view-atlas-data-sync>studio/view-atlas-data-sync</a></li>
<!-- end insert-links -->
  • Loading branch information
MongoCaleb authored Oct 1, 2024
1 parent 24df3e6 commit e7666fd
Show file tree
Hide file tree
Showing 14 changed files with 24 additions and 40 deletions.
4 changes: 2 additions & 2 deletions examples/dart/test/app_services_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
Original file line number Diff line number Diff line change
@@ -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);
Expand Down
4 changes: 2 additions & 2 deletions source/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,6 @@ connect to a different server:

- Your App Services App uses :ref:`local deployment <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 <edge-server-connect-from-client>`.

You can specify a ``baseURL`` in the
:dotnet-sdk:`AppConfiguration <reference/Realms.Sync.AppConfiguration.html#Realms_Sync_AppConfiguration_BaseUri>`.
Expand All @@ -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() <reference/Realms.Sync.App.html#Realms_Sync_App_UpdateBaseUriAsync_System_Uri_>`
method:
Expand Down
8 changes: 3 additions & 5 deletions source/sdk/flutter/app-services/connect-to-app.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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:`<local-deployment>` 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:`<local-deployment>` App Services documentation.

You can specify a ``baseUrl`` in the
:flutter-sdk:`AppConfiguration <realm/AppConfiguration-class.html>`:
Expand All @@ -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 <realm/App/updateBaseUrl.html>` method. You can
Expand Down
15 changes: 3 additions & 12 deletions source/sdk/kotlin/app-services/connect-to-app-services-backend.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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:`<local-deployment>` 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:`<local-deployment>` App Services documentation.

You can specify a ``baseUrl`` in the
`AppConfiguration <{+kotlin-sync-prefix+}io.realm.kotlin.mongodb/-app-configuration/index.html>`__:
Expand All @@ -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
Expand All @@ -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`.
Expand Down
3 changes: 2 additions & 1 deletion source/sdk/kotlin/realm-database/crud/read.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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:`<rql>` reference documentation.
operators and syntax, refer to the :ref:`Realm Query Language <rql>` reference
documentation.

In the following example, we query a ``Frog`` object type and filter by the
``name`` property:
Expand Down
3 changes: 2 additions & 1 deletion source/sdk/kotlin/realm-database/open-and-close-a-realm.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <realm-studio>`.

If you don't want to create a ``.realm`` file or its associated auxiliary
files, you can open an in-memory realm.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,6 @@ connect to a different server:

- Your App Services App uses :ref:`local deployment <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 <edge-server-connect-from-client>`.

You can specify a ``baseURL`` in the
:js-sdk:`AppConfiguration <types/Realm.AppConfiguration.html>`:
Expand All @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion source/sdk/node/model-data/data-types/counters.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <realm-query-language>`.
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,6 @@ connect to a different server:

- Your App Services App uses :ref:`local deployment <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 <edge-server-connect-from-client>`.

You can specify a ``baseURL`` as a prop for :ref:`AppProvider <react-native-app-provider>`.
All :js-sdk:`AppConfiguration <types/Realm.AppConfiguration.html>` keys can be
Expand All @@ -118,8 +117,7 @@ Connect to a Different Server During Runtime
.. versionchanged:: ``[email protected]``

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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,6 @@ connect to a different server:

- Your App Services App uses :ref:`local deployment <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 <edge-server-connect-from-client>`.

You can specify a ``baseURL`` in the
:swift-sdk:`AppConfiguration <Extensions/AppConfiguration.html>`:
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion source/sdk/swift/realm-files.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <ios-default-and-file-url-realm>` 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 <realm-studio>`.

.. _ios-in-memory-realm:

Expand Down
2 changes: 1 addition & 1 deletion source/studio/view-atlas-data-sync.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <realm-query-language>` reference.

Device Sync supports using a subset of RQL operators in Sync subscription
queries. For information on these limitations, refer to
Expand Down

0 comments on commit e7666fd

Please sign in to comment.