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-33121): C++: Update Sync error handling docs for v0.4.0-preview #3081

Merged
merged 9 commits into from
Nov 28, 2023

Conversation

dacharyc
Copy link
Collaborator

@dacharyc dacharyc commented Nov 16, 2023

Pull Request Info

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

Release Notes

  • C++ SDK
    • Update App init examples throughout docs to use realm::App(configuration).
    • Add version changed details throughout docs to specify realm::App(...) deprecation in favor of realm::App(configuration) in v0.4.0-preview.
    • Sync Data
      • Write to a Synced Realm: New page similar to other SDKs with tested, Bluehawked code examples about sync subscriptions, permissions, and compensating writes.

Review Guidelines

REVIEWING.md

Copy link

github-actions bot commented Nov 16, 2023

Readability for Commit Hash: eec52a4

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

Readability scores for changed documents:

  • source/sdk/cpp/sync: Grade Level: 10.0, Reading Ease: 48.7
  • source/sdk/cpp/users/authenticate-users: Grade Level: 8.0, Reading Ease: 59.09
  • source/sdk/cpp/app-services/call-a-function: Grade Level: 9.2, Reading Ease: 61.46
  • source/sdk/cpp/app-services/connect-to-app: Grade Level: 7.9, Reading Ease: 59.5
  • source/sdk/cpp/sync/write-to-synced-realm: Grade Level: 10.0, Reading Ease: 53.92
  • source/sdk/cpp/sync/handle-sync-errors: Grade Level: 7.7, Reading Ease: 54.49
  • source/sdk/cpp/sync/sync-subscriptions: Grade Level: 7.1, Reading Ease: 66.84
  • source/sdk/cpp/sync/stream-data-to-atlas: Grade Level: 10.6, Reading Ease: 46.98
  • source/sdk/cpp/realm-files/configure-and-open-a-realm: Grade Level: 7.8, Reading Ease: 65.22

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.

@dacharyc dacharyc marked this pull request as ready for review November 17, 2023 22:15
Copy link
Collaborator

@cbullinger cbullinger left a comment

Choose a reason for hiding this comment

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

LGTM with some non-blocking comments

source/sdk/cpp/sync/write-to-synced-realm.txt Show resolved Hide resolved
Client Data Model and Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Using the :ref:`object model <cpp-sync-example-object-model>`, the examples
Copy link
Collaborator

Choose a reason for hiding this comment

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

this may just be copying the other pages, but this link to the very previous section doesn't seem helpful to me. and the current wording is also a bit confusing: "the examples configure..."?

Suggested change
Using the :ref:`object model <cpp-sync-example-object-model>`, the examples
Using the example object model, the synced realm is configured to ...

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yeah, it is just copying the other pages, but I left this link here because the object model we're referencing was past all the App Services configuration stuff. So it wasn't directly above this code - it's a bit of a distance away. I wanted it to be easily accessible for someone who wanted to see it as it relates to the sync query.

I guess I could use a tab here to let people easily swap back and forth between the sync query and the object model, instead of making a link you have to click. Let me experiment with that...

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I replaced this with a tab, instead. What do you think of this approach, @cbullinger ? We aren't really doing this anywhere else in the docs and I'm undecided how I feel about it.

source/sdk/cpp/sync/write-to-synced-realm.txt Outdated Show resolved Hide resolved
source/sdk/cpp/sync/write-to-synced-realm.txt Outdated Show resolved Hide resolved
source/sdk/cpp/users/authenticate-users.txt Outdated Show resolved Hide resolved
source/sdk/cpp/sync/handle-sync-errors.txt Outdated Show resolved Hide resolved
source/sdk/cpp/sync/handle-sync-errors.txt Outdated Show resolved Hide resolved
source/sdk/cpp/sync/stream-data-to-atlas.txt Outdated Show resolved Hide resolved
source/sdk/cpp/sync/sync-subscriptions.txt Outdated Show resolved Hide resolved
source/sdk/cpp/sync/sync-subscriptions.txt Outdated Show resolved Hide resolved
@dacharyc dacharyc merged commit f2d5aca into mongodb:master Nov 28, 2023
6 checks passed
@dacharyc dacharyc deleted the DOCSP-33121 branch November 28, 2023 22:00
@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