Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCSP-34240: Document metadata encryption in Kotlin SDK #3074

Merged

Conversation

cbullinger
Copy link
Collaborator

Pull Request Info

Update existing Encrypt a Realm and Connect to App Services pages with info on App metadata encryption.

Jira

Staged Changes

Reminder Checklist

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

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

Review Guidelines

REVIEWING.md

Copy link

github-actions bot commented Nov 9, 2023

Readability for Commit Hash: 0413956

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

Readability scores for changed documents:

  • source/sdk/swift/realm-files/encrypt-a-realm: Grade Level: 8.9, Reading Ease: 56.76
  • source/sdk/react-native/realm-files/encrypt: Grade Level: 9.3, Reading Ease: 55.74
  • source/sdk/flutter/realm-database/realm-files/encrypt: Grade Level: 8.8, Reading Ease: 57.16
  • source/sdk/node/realm-files/encrypt: Grade Level: 8.6, Reading Ease: 57.67
  • source/sdk/kotlin/realm-database/realm-files/encrypt-a-realm: Grade Level: 9.8, Reading Ease: 49.11
  • source/sdk/kotlin/app-services/connect-to-app-services-backend: Grade Level: 9.3, Reading Ease: 55.95
  • source/sdk/dotnet/realm-files/encrypt-a-realm: Grade Level: 8.7, Reading Ease: 57.47

For Grade Level, aim for 8 or below.

For Reading Ease scores, aim for 60 or above:

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

For help improving readability, try Hemingway App.

@cbullinger cbullinger force-pushed the docsp-34240-encrypt-app-metadata branch from ff291b9 to 32e6a45 Compare November 9, 2023 16:05
Copy link
Collaborator

@dacharyc dacharyc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall, LGTM! But since you're tweaking the Encrypt a Realm page here, I wonder if you want to mention something about adding encryption to an existing realm - i.e. recommend writeCopyTo() and link out to the relevant section on the "Configure and Open a Realm" page?

(Or even include the example from that page here so it's on the encryption page?)

@cbullinger cbullinger force-pushed the docsp-34240-encrypt-app-metadata branch from 28bc4cf to 3206049 Compare November 13, 2023 13:05
@cbullinger cbullinger force-pushed the docsp-34240-encrypt-app-metadata branch from 3206049 to 0413956 Compare November 13, 2023 13:08
@cbullinger cbullinger merged commit 2d6438a into mongodb:master Nov 13, 2023
6 checks passed
@cbullinger cbullinger deleted the docsp-34240-encrypt-app-metadata branch November 13, 2023 13:16
@docs-builder-bot
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants