Skip to content

Commit a415d84

Browse files
authored
(DOCSP-23734) Rename Realm to App Services (#543)
* (DOCSP-23734) Rename Realm to App Services
1 parent 245aacc commit a415d84

14 files changed

+89
-91
lines changed

snooty.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ toc_landing_pages = ["/installation", "/dashboards", "/data-sources",
2323

2424
[constants]
2525
version = "v0.10.0"
26+
app-services = "App Services"
27+
atlas-app-services = "Atlas App Services"
28+
atlas-app-services-link = ":appservices:`Atlas App Services </>`"
2629

2730
[substitutions]
2831
charts = "MongoDB Charts"

source/configure-auth-providers.txt

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,20 +32,21 @@ Considerations
3232

3333
- |charts-short| supports these authentication providers:
3434

35-
- :stitch:`Realm </authentication/>`
35+
- :stitch:`Atlas App Services </authentication/>`
3636
- Google
3737
- Custom |jwt|
3838

39-
Realm Providers
40-
~~~~~~~~~~~~~~~
39+
{+atlas-app-services+} Providers
40+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4141

42-
|charts-short| considers tokens from Realm providers valid if they:
42+
|charts-short| considers tokens from {+app-services+} providers valid if
43+
they:
4344

4445
- Are syntactically valid |jwt|\s.
4546

4647
- Are issued by the relevant authority.
4748

48-
- Match the Realm App ID you configure the provider to accept.
49+
- Match the {+app-services+} App ID you configure the provider to accept.
4950

5051
Google Providers
5152
~~~~~~~~~~~~~~~~

source/dashboard-refresh.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,9 @@ on both the client and server.
158158
.. note::
159159

160160
If your chart is embedded using
161-
:ref:`Realm Authentication <stitch-sdk-tutorial>` and
162-
:guilabel:`Fetch data using Realm App` is enabled in your
161+
:ref:`Atlas App Services Authentication <stitch-sdk-tutorial>`
162+
and
163+
:guilabel:`Fetch data using Atlas App Services` is enabled in your
163164
:ref:`Authentication Provider Settings
164165
<configure-auth-providers>`, your chart does not load data from
165166
the server cache. Your ``maxDataAge`` embedding parameter still

source/embed-chart-stitch-auth.txt

Lines changed: 21 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _stitch-sdk-tutorial:
22

3-
======================================
4-
Embed a Chart Authenticated with Realm
5-
======================================
3+
=====================================================
4+
Embed a Chart Authenticated with {+atlas-app-services+}
5+
=====================================================
66

77
.. default-domain:: mongodb
88

@@ -12,32 +12,26 @@ Embed a Chart Authenticated with Realm
1212
:depth: 2
1313
:class: singlecol
1414

15-
.. note::
16-
17-
For the purposes of this tutorial, the names ``Realm`` and ``Stitch``
18-
are used interchangably. They both refer to the :stitch:`MongoDB platform
19-
as a service </>`.
20-
21-
:stitch:`MongoDB Realm </>` is a serverless platform that enables developers
15+
{+atlas-app-services-link+} is a serverless platform that enables developers
2216
to quickly build applications without having to set up server infrastructure.
23-
Realm offers several authentication options, including `Google OAuth
17+
{+app-services+} offers several authentication options, including `Google OAuth
2418
<https://developers.google.com/identity/protocols/oauth2>`__, `Facebook Login
2519
<https://developers.facebook.com/docs/facebook-login/>`__, and email/password.
26-
You can use the authentication mechanism from a Realm app to control data
27-
access for an embedded chart.
20+
You can use the authentication mechanism from an app service to control
21+
data access for an embedded chart.
2822

2923
This tutorial shows you how to:
3024

3125
- Enable authenticated embedding for a chart.
3226
- Use the Embedding SDK to embed a chart authenticated by a custom
33-
:stitch:`Realm </>` provider.
34-
- Use your Realm app to control the data in your embedded chart.
27+
{+atlas-app-services-link+} provider.
28+
- Use your app service to control the data in your embedded chart.
3529

3630
.. note::
3731

38-
This tutorial does not cover creating a Realm app with authentication.
39-
See the :stitch:`Realm documentation </tutorials/>` for app creation
40-
tutorials.
32+
This tutorial does not cover creating an app service with authentication.
33+
See the :stitch:`Atlas App Services documentation </tutorials/>` for
34+
app creation tutorials.
4135

4236
Prerequisites
4337
-------------
@@ -47,7 +41,7 @@ Prerequisites
4741
configure embedding authentication providers for your linked
4842
|charts-short| instance.
4943

50-
- You must have a chart which uses your Realm app's backing database as
44+
- You must have a chart which uses your app's backing database as
5145
its :ref:`data source <data-sources>`. For more information about creating
5246
a chart, see :ref:`Build Charts <build-charts>`.
5347

@@ -61,8 +55,8 @@ Enable Authenticated Embedding for a Chart
6155

6256
.. include:: /includes/steps/embed-chart-authenticated.rst
6357

64-
Configure |charts-short| to use your Custom Realm Provider
65-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
58+
Configure |charts-short| to use your Custom {+atlas-app-services+} Provider
59+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6660

6761
.. include:: /includes/steps/add-auth-stitch-tutorial.rst
6862

@@ -74,18 +68,18 @@ to add an :ref:`embedded chart <embedding-charts-sdk>`.
7468
If not, proceed with the remaining steps to create a new app.
7569

7670
MongoDB offers a pre-built example app that shows how to use the
77-
Embedding SDK to display an embedded chart using Realm authentication.
71+
Embedding SDK to display an embedded chart using {+app-services+} authentication.
7872

7973
Clone the :github:`GitHub repository
8074
</mongodb-js/charts-embed-sdk/tree/master/examples/charts/authenticated-realm>` and
81-
follow the instructions in the ``Readme`` file to begin using the app. You can
82-
run the app as-is, or you can customize it to use the chart you created
83-
earlier.
75+
follow the instructions in the ``Readme`` file to begin using the app.
76+
You can run the app as-is, or you can customize it to use the chart you
77+
created earlier.
8478

8579
.. note::
8680

87-
The example app assumes that your Realm app uses email/password
88-
authentication. If your Realm app uses another authentication mechanism,
81+
The example app assumes that your app service uses email/password
82+
authentication. If your app service uses another authentication mechanism,
8983
the example app will require additional customization.
9084

9185
Customize the Node.js App

source/embedded-chart-error-codes.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,5 +151,5 @@ Refer to the following table for more information on each error code.
151151
* - ``18``
152152
- Client ID doesn't match provider.
153153

154-
- This error occurs for Realm and Google authentication providers
154+
- This error occurs for {+atlas-app-services+} and Google authentication providers
155155
if the token is valid but was issued for a different application.

source/embedding-tutorials.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ login credentials through an SSO provider.
3030
the rendering of embedded charts in an application.
3131

3232
:ref:`stitch-sdk-tutorial`
33-
Configure |charts-short| to use :stitch:`MongoDB Realm </>` to authorize
33+
Configure |charts-short| to use {+atlas-app-services-link+} to authorize
3434
the rendering of embedded charts in an application.
3535

3636
:ref:`jwt-sdk-tutorial`

source/filter-embedded-charts.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -264,12 +264,12 @@ sensitive information.
264264

265265
.. note::
266266

267-
If you use a Realm Authentication Provider, ``context.token``
268-
contains the Realm
267+
If you use an {+atlas-app-services+} authentication provider, ``context.token``
268+
contains the {+app-services+}
269269
:atlas:`user object </app-services/authentication/user-objects/>` to
270270
filter. For example, if you enable
271271
:atlas:`Custom User Data </app-services/users/enable-custom-user-data/>`
272-
for Realm users, the user object is available in
272+
for {+app-services+} users, the user object is available in
273273
``context.token.custom_data``.
274274

275275
To inject a filter specific to each user, in the

source/get-started-embedding-sdk.txt

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ Create a Web App
132132
MongoDB offers :github:`examples of authenticated embedded dashboards </mongodb-js/charts-embed-sdk/tree/master/examples/dashboard/>`
133133
in the GitHub Repository. These examples show you how to use
134134
the Embedding SDK to authenticate an embedded dashboard using
135-
:stitch:`MongoDB Realm </>`, Google, or |jwt| authentication
135+
{+atlas-app-services-link+}, Google, or |jwt| authentication
136136
providers.
137137

138138
Add Embedding Code to Your App
@@ -186,13 +186,12 @@ To learn how to install the Embedding SDK into your app, see
186186
Add the following code to your web app to execute where you
187187
want your chart to render. The following example
188188
:ref:`authenticates <configure-auth-providers>` with
189-
:stitch:`MongoDB Realm </>`.
189+
{+atlas-app-services-link+}.
190190

191191
.. note::
192192

193-
Replace the existing Realm App ID with your Realm App
194-
ID, which you can find on the left side of your Realm
195-
app UI. Replace the existing Charts Base URL and chart
193+
Replace the existing App ID with your App
194+
ID, which you can find in the {+atlas-app-services+} UI. Replace the existing Charts Base URL and chart
196195
ID with the values for the chart that you want to
197196
display. Your Charts Base URL and chart ID are visible
198197
in the embedding options modal window.
@@ -202,16 +201,16 @@ To learn how to install the Embedding SDK into your app, see
202201

203202
import ChartsEmbedSDK from "@mongodb-js/charts-embed-dom";
204203

205-
// Needed only if you are using the Realm authentication provider
204+
// Needed only if you are using the Atlas App Services authentication provider
206205
const client = Stitch.initializeAppClient(
207-
'realm-authentication-sample-eibkj', // ~REPLACE~ with your Realm App ID
206+
'authentication-sample-eibkj', // ~REPLACE~ with your App ID
208207
});
209208

210209
const sdk = new ChartsEmbedSDK({
211210
baseUrl: "https://charts.mongodb.com/charts-embedding-examples-wgffp", // ~REPLACE~ with the Base URL from your Embed Chart dialog.
212211
getUserToken: () => getRealmUserToken(client),
213212
// getUserToken is a callback to provide the auth token to the SDK.
214-
// Use the getRealmUserToken helper when using the Realm auth provider.
213+
// Use the getRealmUserToken helper when using the Atlas App Services auth provider.
215214
// If using Custom JWT or Google providers, provide your own code to retrieve the JWT
216215
});
217216

@@ -267,13 +266,12 @@ To learn how to install the Embedding SDK into your app, see
267266
Add the following code to your web app to run it where you
268267
want your dashboard to render. The following example
269268
:ref:`authenticates <configure-auth-providers>` with
270-
:stitch:`MongoDB Realm </>`.
269+
{+atlas-app-services-link+}.
271270

272271
.. note::
273272

274-
Replace the existing Realm App ID with your Realm
275-
App ID. You can find the Realm ID on the left side
276-
of your Realm app UI. Replace the existing :guilabel:`Dashboards
273+
Replace the existing App ID with your
274+
App ID. You can find your App ID in the {+atlas-app-services+} UI. Replace the existing :guilabel:`Dashboards
277275
Base URL` and dashboard ID with the values for the
278276
dashboard that you want to display. Your :guilabel:`Dashboards Base URL`
279277
and dashboard ID are visible in the embedding options
@@ -284,16 +282,16 @@ To learn how to install the Embedding SDK into your app, see
284282

285283
import ChartsEmbedSDK from "@mongodb-js/charts-embed-dom";
286284

287-
// Needed only if you are using the Realm authentication provider
285+
// Needed only if you are using the Atlas App Services authentication provider
288286
const client = Stitch.initializeAppClient(
289-
'realm-authentication-sample-eibkj', // ~REPLACE~ with your Realm App ID
287+
'authentication-sample-eibkj', // ~REPLACE~ with your App ID
290288
});
291289

292290
const sdk = new ChartsEmbedSDK({
293291
baseUrl: "https://charts.mongodb.com/charts-embedding-examples-wgffp", // ~REPLACE~ with the Base URL from your Embed Dashboard dialog.
294292
getUserToken: () => getRealmUserToken(client),
295293
// getUserToken is a callback to provide the auth token to the SDK.
296-
// Use the getRealmUserToken helper when using the Realm auth provider.
294+
// Use the getRealmUserToken helper when using the Atlas App Services auth provider.
297295
// If using Custom JWT or Google providers, provide your own code to retrieve the JWT
298296
});
299297

source/includes/list-table-auth-provider-options.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
2020
<prefix>.apps.googleusercontent.com
2121
22-
* - Realm
22+
* - {+atlas-app-services+}
2323
- Provide the following values:
2424

25-
.. include:: /includes/list-table-realm-auth-provider-options.rst
25+
.. include:: /includes/list-table-realm-auth-provider-options.rst

source/includes/list-table-realm-auth-provider-options.rst

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,28 +7,29 @@
77
- Value
88

99
* - Project
10-
- Project that contains your Realm application.
10+
- Project that contains your app service.
1111

12-
* - Realm App
13-
- Realm app that's issuing the user token.
12+
* - App Service
13+
- App service that's issuing the user token.
1414

15-
* - Fetch data using Realm app (**Optional**)
15+
* - Fetch data using {+atlas-app-services+} (**Optional**)
1616
- Toggle to enable |charts-short| to fetch user data and rules from
17-
a Realm Service.
17+
an app service.
1818

1919
If enabled, |charts-short| retrieves data from the service you
20-
specify in the :guilabel:`Realm Service Name` field.
20+
specify in the :guilabel:`App Service Name` field.
2121

22-
Enabling this option allows you to define rules in Realm to
22+
Enabling this option allows you to define rules in {+atlas-app-services+} to
2323
control the data that |charts-short| displays for specific
2424
collections or users.
2525

2626
For more information, see :stitch:`Filter Incoming Queries
27-
</mongodb/filter-incoming-queries/>` in the Realm documentation.
27+
</mongodb/filter-incoming-queries/>` in the {+app-services+}
28+
documentation.
2829

29-
* - Realm Service Name
30-
- The name of the service in your Realm app that |charts-short| uses
31-
to retrieve the data for your chart.
30+
* - App Service Name
31+
- The name of the service in your app service that |charts-short|
32+
uses to retrieve the data for your chart.
3233

3334
.. example::
3435

0 commit comments

Comments
 (0)