(DOCSP-33626) Document metadata encryption #3068
Conversation
- Add test for encrypting metadata - Add test for encrypting a realm - Generate snippets - Remove old encrypt example - Add content and clean up old content
|
Readability for Commit Hash: a0fe4ff You can see any previous Readability scores (if they exist) by looking Readability scores for changed documents:
For Grade Level, aim for 8 or below. For Reading Ease scores, aim for 60 or above:
For help improving readability, try Hemingway App. |
- Add React Native versions of encryption
|
The React Native test suite has an unrelated failing test. I'm looking into that separately. |
|
|
||
| To encrypt App metadata: | ||
|
|
||
| #. Import ``MetadataMode`` from ``Realm``. |
There was a problem hiding this comment.
just curious why we're not including the explicit import statements like we've done in the RN Connect to an App Services page
There was a problem hiding this comment.
Good question! Mostly because the imports are less... intense for Node. But it would still be good to include them. Thanks for pointing this out.
|
|
||
| #. Import ``MetadataMode`` from ``Realm``. | ||
| #. Create an App configuration object that contains the ``metadata`` property. | ||
| #. Set ``metadata.mode`` to a value from the ``MetadataMode`` enum. |
There was a problem hiding this comment.
for the purposes of this procedure, would you only use Encryption or am I misreading the other enum values?
There was a problem hiding this comment.
Hmm, yeah. I should probably explain what the enum values mean. Although for now, just documenting Encryption is probably enough?
source/sdk/node/app-services/connect-to-app-services-backend.txt
Outdated
Show resolved
Hide resolved
source/sdk/react-native/app-services/connect-to-app-services-app.txt
Outdated
Show resolved
Hide resolved
| .. include:: /examples/generated/react-native/v12/EncryptMetadata.snippet.imports.tsx.rst | ||
|
|
||
| #. Create an App configuration object that contains the ``metadata`` property. | ||
| #. Set ``metadata.mode`` to a value from the ``MetadataMode`` enum. |
| @@ -0,0 +1,13 @@ | |||
| .. code-block:: typescript | |||
| :emphasize-lines: 1, 7, 7 | |||
There was a problem hiding this comment.
ah, interesting. looks like those duped emphasize lines are happening in your generated snippets too. i wonder what's causing it... 🤔
There was a problem hiding this comment.
Huh. That's really odd! I rarely look at the generated snippets themselves, so it's probably in a lot of my snippets.
Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com>
|
✨ Staging URL: https://preview-mongodbmongodb.gatsbyjs.io/realm/master/ 🪵 Logs |
Pull Request Info
Jira
Staged Changes
Review Guidelines
REVIEWING.md
Animal Wearing a Hat