From e342e21c968b16e243492854377e34a74d7963e4 Mon Sep 17 00:00:00 2001 From: Kyle Rollins <115574589+krollins-mdb@users.noreply.github.com> Date: Mon, 1 Apr 2024 15:28:53 -0500 Subject: [PATCH] (DOCSP-37832) Standardize "provider" capitalization to support translation needs (#3213) ## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-37832 - [React Native SDK](https://preview-mongodbkrollinsmdb.gatsbyjs.io/realm/DOCSP-37832/sdk/react-native/) ### Reminder Checklist Before merging your PR, make sure to check a few things. - [x] Did you tag pages appropriately? - genre - meta.keywords - meta.description - [x] Describe your PR's changes in the Release Notes section - [x] Create a Jira ticket for related docs-app-services work, if any ### Release Notes - **React Native SDK** - Throughout: Standardize "provider" capitalization to support translation needs ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) ### Animal Wearing a Hat --- .../api-reference/realm-provider.txt | 16 ++++++++-------- .../manage-users/manage-email-password-users.txt | 4 ++-- .../realm-files/configure-a-realm.txt | 4 ++-- .../sync-data/configure-a-synced-realm.txt | 8 ++++---- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/source/sdk/react-native/api-reference/realm-provider.txt b/source/sdk/react-native/api-reference/realm-provider.txt index 1c89f619a1..57573b3e3e 100644 --- a/source/sdk/react-native/api-reference/realm-provider.txt +++ b/source/sdk/react-native/api-reference/realm-provider.txt @@ -70,8 +70,8 @@ data models, refer to :ref:`Define a Realm Object Model that exposes a realm to its child components. You configure your realm by passing props to ``RealmProvider``. - When ``RealmProvider`` is rendered, it opens the realm. This means that the - provider renders successfully or its child components can't access the realm. + When ``RealmProvider`` is rendered, it opens the realm. This means that + the child components can't access the realm if rendering fails. In addition to ``RealmProvider``, you also need to configure :ref:`AppProvider ` and :ref:`UserProvider @@ -109,8 +109,8 @@ data models, refer to :ref:`Define a Realm Object Model that exposes a realm to its child components. You configure your realm by passing props to ``RealmProvider``. - When ``RealmProvider`` is rendered, it opens the realm. This means that the - provider renders successfully or its child components can't access the realm. + When ``RealmProvider`` is rendered, it opens the realm. This means that + the child components can't access the realm if rendering fails. To configure a non-synced realm: @@ -125,16 +125,16 @@ data models, refer to :ref:`Define a Realm Object Model Configure More Than One Realm ----------------------------- -When you import ``RealmProvider`` from ``@realm/react``, that provider has a +When you import ``RealmProvider`` from ``@realm/react``, that Provider has a specific context and is associated with a single realm. If you need to configure -more than one realm, use ``createRealmContext()`` to instantiate a new provider +more than one realm, use ``createRealmContext()`` to instantiate a new Provider for each realm. If you import ``useRealm()``, ``useQuery()``, or ``useObject()`` directly from ``@realm/react``, those hooks use the default realm context. To work with more -than one realm, you need to destructure a new realm provider and its associated +than one realm, you need to destructure a new realm Provider and its associated hooks from the result of ``createRealmContext()``. You should namespace providers -to avoid confusion about which provider and hooks you're working with. +to avoid confusion about which Provider and hooks you're working with. For a detailed guide, refer to :ref:`Expose More Than One Realm `. diff --git a/source/sdk/react-native/manage-users/manage-email-password-users.txt b/source/sdk/react-native/manage-users/manage-email-password-users.txt index 12fd0fe0cb..f09febf1f3 100644 --- a/source/sdk/react-native/manage-users/manage-email-password-users.txt +++ b/source/sdk/react-native/manage-users/manage-email-password-users.txt @@ -109,12 +109,12 @@ Confirm a User's Email Address ------------------------------ New users must confirm that they own their email address before they can log in -to your app unless the provider is configured to :ref:`automatically confirm new +to your app unless the auth provider is configured to :ref:`automatically confirm new users `. The confirmation process starts when you register a user and ends when you confirm them from your client code. Email confirmation requries a valid ``token`` and ``tokenId``. You get these -values from different places depending on the provider configuration: +values from different places depending on the auth provider configuration: - :ref:`Send a confirmation email `. The ``token`` and ``tokenId`` values are included as query parameters in the diff --git a/source/sdk/react-native/realm-files/configure-a-realm.txt b/source/sdk/react-native/realm-files/configure-a-realm.txt index d112022668..d47533d205 100644 --- a/source/sdk/react-native/realm-files/configure-a-realm.txt +++ b/source/sdk/react-native/realm-files/configure-a-realm.txt @@ -34,8 +34,8 @@ Configure a Realm Without Sync that exposes a realm to its child components. You configure your realm by passing props to ``RealmProvider``. -When ``RealmProvider`` is rendered, it opens the realm. This means that the -provider renders successfully or its child components can't access the realm. +When ``RealmProvider`` is rendered, it opens the realm. This means that +the child components can't access the realm if rendering fails. To configure a non-synced realm: diff --git a/source/sdk/react-native/sync-data/configure-a-synced-realm.txt b/source/sdk/react-native/sync-data/configure-a-synced-realm.txt index dc67a4a2dc..66881fe150 100644 --- a/source/sdk/react-native/sync-data/configure-a-synced-realm.txt +++ b/source/sdk/react-native/sync-data/configure-a-synced-realm.txt @@ -126,8 +126,8 @@ RealmProvider that exposes a realm to its child components. You configure your realm by passing props to ``RealmProvider``. -When ``RealmProvider`` is rendered, it opens the realm. This means that the -provider renders successfully or its child components can't access the realm. +When ``RealmProvider`` is rendered, it opens the realm. This means that +the child components can't access the realm if rendering fails. To configure a synced realm: @@ -294,8 +294,8 @@ Sync continues in the background. @realm/react Providers and Hooks -------------------------------- -``@realm/react`` has providers and hooks that simplify working with your synced -realm and its data. Refer to each provider's page to learn about them and +``@realm/react`` has Context Providers and hooks that simplify working with your +synced realm and its data. Refer to each Provider's page to learn about them and their hooks. - :ref:`AppProvider reference `