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-31531): NET SDK Migrate PBS to FS updates #2916

Merged
merged 12 commits into from
Aug 1, 2023

Conversation

dacharyc
Copy link
Collaborator

@dacharyc dacharyc commented Jul 26, 2023

Pull Request Info

Jira

Staged Changes

  • Sync Data: Remove PBS info
  • Configure & Open a Synced Realm: Remove PBS info to new PBS page. Add new Flexible Sync code examples for opening a realm. The other examples on this page should also be updated to show FS instead of PBS, but aren't necessarily a blocker for this PR.
  • Partition-Based Sync: New page with moved PBS content and new migration info

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

@github-actions
Copy link

github-actions bot commented Jul 26, 2023

Readability for Commit Hash: b6bb305

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

Readability scores for changed documents:

  • source/sdk/dotnet/sync: Grade Level: 13.3, Reading Ease: 34.66
  • source/sdk/dotnet/sync/sync-progress: Grade Level: 11.8, Reading Ease: 38.52
  • source/sdk/dotnet/sync/configure-and-open-a-synced-realm: Grade Level: 8.7, Reading Ease: 62.68
  • source/sdk/dotnet/sync/partition-based-sync: Grade Level: 10.2, Reading Ease: 47.99
  • source/sdk/dotnet/sync/flexible-sync: Grade Level: 8.9, Reading Ease: 56.86

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 requested a review from MongoCaleb July 26, 2023 21:13
Copy link
Collaborator

@MongoCaleb MongoCaleb left a comment

Choose a reason for hiding this comment

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

Approving with some open questions. Overall looks great!

source/sdk/dotnet/sync.txt Outdated Show resolved Hide resolved
source/sdk/dotnet/sync/partition-based-sync.txt Outdated Show resolved Hide resolved
source/sdk/dotnet/sync/partition-based-sync.txt Outdated Show resolved Hide resolved
Copy link
Collaborator

@papafe papafe left a comment

Choose a reason for hiding this comment

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

Left some small comments

source/sdk/dotnet/sync/partition-based-sync.txt Outdated Show resolved Hide resolved
#. Create a
:dotnet-sdk:`PartitionSyncConfiguration <reference/Realms.Sync.PartitionSyncConfiguration.html>`
object that includes the :ref:`partition name <partition-value>` and
the :dotnet-sdk:`User <reference/Realms.Sync.User.html>` object.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't think that the snippet is included in this PR, but in the snippet it catches the RealmFileAccessErrorException. It should catch a generic Exception, since there are multiple errors that can be raised at this point

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Got it - updated this example. Thank you!

Copy link
Collaborator

@papafe papafe left a comment

Choose a reason for hiding this comment

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

Left some small comments here and there

@papafe
Copy link
Collaborator

papafe commented Aug 1, 2023

Looks good!

@dacharyc dacharyc force-pushed the DOCSP-31531 branch 8 times, most recently from 8a8e50b to 382bf26 Compare August 1, 2023 19:09
@dacharyc dacharyc merged commit 6f8d782 into mongodb:master Aug 1, 2023
6 checks passed
@dacharyc dacharyc deleted the DOCSP-31531 branch August 1, 2023 20:37
@docs-builder-bot
Copy link

cbullinger pushed a commit to cbullinger/docs-realm that referenced this pull request Aug 7, 2023
## Pull Request Info

### Jira

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

### Staged Changes

- [Sync
Data](https://docs-mongodbcom-staging.corp.mongodb.com/realm/docsworker-xlarge/DOCSP-31531/sdk/dotnet/sync/):
Remove PBS info
- [Configure & Open a Synced
Realm](https://docs-mongodbcom-staging.corp.mongodb.com/realm/docsworker-xlarge/DOCSP-31531/sdk/dotnet/sync/configure-and-open-a-synced-realm/):
Remove PBS info to new PBS page. Add new Flexible Sync code examples for
opening a realm. The other examples on this page should also be updated
to show FS instead of PBS, but aren't necessarily a blocker for this PR.
- [Partition-Based
Sync](https://docs-mongodbcom-staging.corp.mongodb.com/realm/docsworker-xlarge/DOCSP-31531/sdk/dotnet/sync/partition-based-sync/):
New page with moved PBS content and new migration info

### Reminder Checklist

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

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

### Review Guidelines


[REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md)
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.

4 participants