-
Notifications
You must be signed in to change notification settings - Fork 88
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
C++ GA Docs #3137
C++ GA Docs #3137
Conversation
## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-34757 - [Staged Changes](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-34757/): Remove "Preview" and "preview" everywhere EXCEPT as already removed in #3113 and #3130 . There are a couple of places in page copy where I did not remove preview naming because I already did that in the PR that removes the experimental namespace. And there are places in version directives that use the preview naming, but I already deleted those references in the PR that removed the version directives. ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md)
## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-34763 - [C++ Staged Docs](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-34763/sdk/cpp/): Remove version directives that still exist in the docs after removing the experimental namespace. As part of removing the experimental namespace, I removed the "Current" and "Deprecated" tabs, so version directives that exist in those tabs have already been removed in the related PR (#3113 ). Apparently I also removed one on the Quick Start page that was next to a code example I updated. So these changes only touch version directives that were not touched in that PR. I did a search for all the `.. version` directives in C++, and then I did a search for any remaining "version" references, and I compared every instance against the related PR, so I think this is good and includes all instances that should be touched here. But I welcome a second set of eyes! ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md)
## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-35190 - [Reduce Realm File Size](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-35190/sdk/cpp/realm-files/compact-realm/): New page with example for compacting a realm in C++ SDK. Note: This example is in a new one-off unit test suite and uses the experimental namespace. When the SDK merges the PR that removes the experimental namespace, I'll get my corresponding docs PR merged and then move this into the local test suite established there, and remove this from the experimental namespace. ### 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 - **C++ SDK** - Realm Files/Compact a Realm: New page with example for compacting a realm in C++ SDK. ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) --------- Co-authored-by: cbullinger <[email protected]>
## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-35188 - [Configure & Open a Realm](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-35188/sdk/cpp/realm-files/configure-and-open-a-realm/#close-a-realm): New "Close a Realm" section with code example - [Quick Start](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-35188/sdk/cpp/quick-start/#close-a-realm): New "Close a Realm" section with code example ### Reminder Checklist Before merging your PR, make sure to check a few things. - [ ] 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 - **C++ SDK** - Quick Start: New "Close a Realm" section with Bluehawked, tested code example. - Realm Files/Configure & Open a Realm: New "Close a Realm" section with Bluehawked, tested code example. ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md)
## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-34760 - [Handle Sync Errors](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-34760/sdk/cpp/sync/handle-sync-errors/#client-reset): New Client Reset section, with details and code examples showing client reset methods. ### 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 - **C++ SDK** - Sync Data/Handle Sync Errors: Add information and code examples for client reset. ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md)
## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-34756 - [C++ SDK Staged Changes](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-34756/sdk/cpp/) This PR updates the code examples for the C++ GA. - Removes the experimental namespace - Removes the alpha and beta test suites - Removes the Current/Deprecated tabs on the docs pages - Removes the `Tip` directive about features using the experimental namespace - Removes "beta" naming from all code examples This does not remove any beta/preview language from the docs themselves, or change the code examples except minor tweaks required to get the tests to pass. For review, I'm looking for you to check for: - Code examples that should be on the page are present - I've appropriately Bluehawk replaced realm object names to simpler versions - I've removed the Current/Deprecated tabs on all pages - I haven't accidentally removed any text that was in the Current tab of a Current/Deprecated tab - Any model names referred to in the copy on the page matches the model names in the code examples I've done a preliminary check, fixed some things, and I think it looks good, but I'm sure I've missed things. Separate PRs will follow to update the SDK naming, remove version directives, update API reference links, and add new functionality. A few code examples are currently commented out but will still show up on the pages. Support for BSON has been removed from the SDK. I'll split out separate tickets to address those code examples. I am not looking for grammar or wording changes for any page or code example content, unless I've introduced an erroneous change in this PR. The scope of changes is too large for me to address grammar/content errors here. If you spot something egregious, feel free to start a document or Jira ticket with things for me to address as fast follows. ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md)
Readability for Commit Hash: c8ded95 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. |
…t test suites (#3135) ## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-35255 - [Configure & Open a Realm](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-35255/sdk/cpp/realm-files/configure-and-open-a-realm/#close-a-realm): Update close a realm example after moving out of experimental namespace - [Reduce Realm File Size](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-35255/sdk/cpp/realm-files/compact-realm/): Update compact a realm example after moving out of experimental namespace - [Handle Sync Errors](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-35255/sdk/cpp/sync/handle-sync-errors/#client-reset): Update client reset code examples after moving out of experimental namespace ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md)
## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-35187 - [Manage Users/Authenticate Users](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-35187/sdk/cpp/users/authenticate-users/#google-user): Update the Google auth code examples to use the new naming introduced in [v0.6.0](https://github.com/realm/realm-cpp/blob/main/CHANGELOG.md#060-release-notes-2023-12-18). ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md)
## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-35019 - [C++ Staged Docs (Throughout)](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-35019/sdk/cpp/): Updated broken API reference links ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md)
Can't get a staging build from this branch because of the ++ in the name. Keeping this around just in case of git shenanigans, but I will close in favor of #3140 after it's merged successfully. |
## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-35298 ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md)
## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-35298 There is no good reason the Sync tests shouldn't run in the existing workflow. When I run the Sync tests by themselves, they work. So I guess I'll break them out into separate workflows, which will speed them up, anyway, so they can run in parallel instead of serially. Presumably this will also resolve the failing Sync tests, since they worked fine in #3142 when I broke them out separately. ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md)
## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-35186 - [Call a Function](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-35298/sdk/cpp/app-services/call-a-function/): Update examples to remove BSON - [Custom User Data](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-35298/sdk/cpp/users/custom-user-data/): Update examples to remove BSON - [Authentication/Custom Function User](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-35298/sdk/cpp/users/authenticate-users/#custom-function-user): Update example to remove BSON ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md)
Now that the branch from my fork is safely merged in #3140 , I'm closing this one. |
Pull Request Info
This branch is the feature branch for the C++ GA docs updates. DO NOT MERGE until the C++ GA release.
Reminder Checklist
Before merging your PR, make sure to check a few things.
Release Notes
Review Guidelines
REVIEWING.md