(DOCSP-26981): @realm/reactify - Change an Object Model - React Native #2399

mohammadhunan-dev · 2022-12-13T20:52:11Z

Pull Request Info

Jira

https://jira.mongodb.org/browse/DOCSP-26981

Staged Changes

Change an Object Model - React Native

Reminder Checklist

If your PR modifies the docs, you might need to also update some corresponding
pages. Check if completed or N/A.

[N/A] Create Jira ticket for corresponding docs-app-services update(s), if any
[N/A] Checked/updated Admin API
[N/A] Checked/updated CLI reference

Review Guidelines

REVIEWING.md

github-actions · 2022-12-13T21:00:30Z

Readability for Commit Hash: 019253c

You can see any previous Readability scores (if they exist) by looking
at the comment's history.

Flesch Reading Ease scores for changed documents:

source/sdk/react-native/realm-database/change-an-object-model: 55.64

The following table can be helpful in assessing the readability score of a document.

Score	Difficulty
90-100	Very Easy
80-89	Easy
70-79	Fairly Easy
60-69	Medium
50-59	Fairly Hard
30-49	Hard
0-29	Very Hard

source/sdk/react-native/realm-database/change-an-object-model.txt

cbush · 2022-12-13T23:38:28Z

examples/react-native/__tests__/js/realm-database/change-an-object-model-test.jsx

+    // :snippet-start: add-a-property-to-schema
+    // :replace-start: {
+    //  "terms": {
+    //   "MyPerson": "Person"


[q] Why is this replace needed?

There's already a Person schema with different properties used elsewhere in the unit test suite.

mongodben · 2022-12-16T16:41:25Z

source/sdk/react-native/realm-database/change-an-object-model.txt

+   <react-native-schema-version>` ``1`` has a ``Person`` object type with a
   ``firstName``, and ``lastName`` property. The developer decides to add an
   ``age`` property to the ``Person`` class. 

   To migrate the realm to conform to the updated ``Person`` schema, the
-   developer sets the realm's :ref:`schema version <react-native-schema-version>` to
-   ``2``.
+   developer sets the realm's schema version in the ``RealmConfiguration`` to ``2``.
+   Finally, the developer passes the configuration object to the
+   ``createRealmContext()`` method.


to refer to user as 'the developer' here reads weird to me, and goes against the mongoDB style guide, which advocates 2nd person and imperative mood - https://www.mongodb.com/docs/meta/style-guide/writing/write-to-the-user/

could you refactor these sentences with this in mind?

I think we're very inconsistent with using "developer" vs "user" throughout our docs, here are just a few examples of where we use developer (Update a Realm Object Schema - Flutter SDK, Change an Object Model - Swift SDK, Modify an Object Schema - Node.js SDK).

It's an easy enough change for me to make "developer" -> "user" if you feel particularly strongly about it, but I do think we might prefer to use "developer" for the following reasons:

Main reason: "User" is ambiguous. Does this refer to the user using the application, or the user of realm (i.e the application developer), or the reader of this docs page (who may be one of many personas) ?

Supplementary reason: To highlight that this is a specific example of how change the schema. Using the word "developer" indicates that someone else is doing this, not that this is the only way to do it. The

Also, it seems like the mongoDB style guide is specifically advocating not to use the phrase "the user".

ok, but i was commenting that it should be changed to 2nd person ('you') or imperative, not 'user', so i think the initial comment still stands.

Got it, altered to 'you' instead now.

source/sdk/react-native/realm-database/change-an-object-model.txt

examples/react-native/__tests__/js/realm-database/change-an-object-model-test.jsx

examples/react-native/__tests__/ts/realm-database/change-an-object-model-test.tsx

examples/react-native/__tests__/js/realm-database/change-an-object-model-test.jsx

mongodben

nice work! just couple of small things.

source/sdk/react-native/realm-database/change-an-object-model.txt

mongodben · 2023-01-03T21:08:29Z

source/sdk/react-native/realm-database/change-an-object-model.txt

-   ``2`` and defines a migration function to convert the ``Object ID`` type to a
-   ``string`` type.
+   To migrate the realm to conform to the updated ``Task`` schema, the developer
+   creates a :js-sdk:`Configuration <Realm.html#~Configuration>` object and


[suggestion] don't make this a link b/c you link to this just a few lines above

https://github.com/mongodb/docs-realm/pull/2399/files#diff-e4287620889b14ddb45f89cb33481d6ca1eff15446ff3d03b465e670f8707025R228-R229

mongodben

looking better, just a few things remaining

Co-authored-by: Ben Perlmutter <[email protected]>

mongodben · 2023-01-04T18:10:43Z

source/sdk/react-native/realm-database/change-an-object-model.txt

   To migrate the realm to conform to the updated ``Person`` schema, the
-   developer sets the realm's :ref:`schema version <react-native-schema-version>` to
-   ``2``.
+   developer sets the realm's schema version in the ``Configuration`` to ``2``.


change to imperative/2nd person

mongodben · 2023-01-04T18:11:18Z

source/sdk/react-native/realm-database/change-an-object-model.txt

-   developer sets the realm's :ref:`schema version <react-native-schema-version>` to
-   ``2``.
+   developer sets the realm's schema version in the ``Configuration`` to ``2``.
+   Finally, you pass the configuration object to the


Suggested change

Finally, you pass the configuration object to the

Finally, pass the configuration object to the

mongodben · 2023-01-04T18:12:01Z

source/sdk/react-native/realm-database/change-an-object-model.txt

+   To migrate the realm to conform to the updated ``Person`` schema, the
+   developer sets the realm's schema version to 2 in the ``Configuration``


Suggested change

To migrate the realm to conform to the updated ``Person`` schema, the

developer sets the realm's schema version to 2 in the ``Configuration``

To migrate the realm to conform to the updated ``Person`` schema,

set the realm's schema version to 2 in the ``Configuration``

mongodben · 2023-01-04T18:12:10Z

source/sdk/react-native/realm-database/change-an-object-model.txt

+
+   To migrate the realm to conform to the updated ``Person`` schema, the
+   developer sets the realm's schema version to 2 in the ``Configuration``
+   object. Finally, you pass the configuration object to the


Suggested change

object. Finally, you pass the configuration object to the

object. Finally, pass the configuration object to the

mongodben · 2023-01-04T18:12:30Z

source/sdk/react-native/realm-database/change-an-object-model.txt

-   developer sets the realm's :ref:`schema version <react-native-schema-version>` to
-   ``2`` and defines a migration function to set the value of ``fullName`` based
-   on the existing ``firstName`` and ``lastName`` properties.
+   To migrate the realm to conform to the updated ``Person`` schema, you create a :js-sdk:`Configuration <Realm.html#~Configuration>` object


Suggested change

To migrate the realm to conform to the updated ``Person`` schema, you create a :js-sdk:`Configuration <Realm.html#~Configuration>` object

To migrate the realm to conform to the updated ``Person`` schema, create a :js-sdk:`Configuration <Realm.html#~Configuration>` object

mongodben · 2023-01-04T18:12:44Z

source/sdk/react-native/realm-database/change-an-object-model.txt

+   To migrate the realm to conform to the updated ``Person`` schema, you create a :js-sdk:`Configuration <Realm.html#~Configuration>` object
+   and set the realm's schema version to ``2``, and define a migration function that
+   sets the value of ``fullName`` based on the existing ``firstName`` and ``lastName``
+   properties. Finally, you pass the configuration object to the


Suggested change

properties. Finally, you pass the configuration object to the

properties. Finally, pass the configuration object to the

mongodben · 2023-01-04T18:13:03Z

source/sdk/react-native/realm-database/change-an-object-model.txt

-   developer sets the realm's :ref:`schema version <react-native-schema-version>` to
-   ``2`` and defines a migration function to convert the ``Object ID`` type to a
-   ``string`` type.
+   To migrate the realm to conform to the updated ``Task`` schema, you create a


Suggested change

To migrate the realm to conform to the updated ``Task`` schema, you create a

To migrate the realm to conform to the updated ``Task`` schema, create a

mongodben · 2023-01-04T18:13:11Z

source/sdk/react-native/realm-database/change-an-object-model.txt

+   To migrate the realm to conform to the updated ``Task`` schema, you create a
+   ``Configuration`` object and set the realm's schema version to ``2``, and
+   define a migration function to convert the integer type to an ``Object ID``
+   type. Finally, you pass the configuration object to the


Suggested change

type. Finally, you pass the configuration object to the

type. Finally, pass the configuration object to the

mongodben

lgtm. some small suggestions about the 2nd person/imperative throughout

#2399) ## Pull Request Info ### Jira - https://jira.mongodb.org/browse/DOCSP-26981 ### Staged Changes - [Change an Object Model - React Native](https://docs-mongodbcom-staging.corp.mongodb.com/realm/docsworker-xlarge/DOCSP-26981-Change-A-ROM/sdk/react-native/realm-database/change-an-object-model/) ### Reminder Checklist If your PR modifies the docs, you might need to also update some corresponding pages. Check if completed or N/A. - [N/A] Create Jira ticket for corresponding docs-app-services update(s), if any - [N/A] Checked/updated Admin API - [N/A] Checked/updated CLI reference ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) Co-authored-by: Mohammad Hunan Chughtai <[email protected]> Co-authored-by: Ben Perlmutter <[email protected]>

Mohammad Hunan Chughtai added 2 commits December 13, 2022 15:51

added change an object model tests

1a5396e

added literal includes to add a prop

d057a17

Mohammad Hunan Chughtai added 8 commits December 13, 2022 16:06

literal included generated files

e009254

fix rst on tabs

1f181d0

added more comments

a8c12ee

wording improvements

cc0136a

fix line emphasis

d1c38de

wording improvements

6d1d35c

remove mention of opening a realm

13661ce

grammar fixes

4e9884a

mohammadhunan-dev changed the title ~~(DOCSP-26981): Change an Object Model - React Native~~ (DOCSP-26981): @realm/reactify - Change an Object Model - React Native Dec 13, 2022