(DOCSP-39540) Consolidate Partition-Based Sync page #3279
Conversation
|
Readability for Commit Hash: 3f4931f 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. |
dacharyc
added
the
merge to feature branch
| @@ -4,10 +4,213 @@ | |||
| Partition-Based Sync | |||
| ==================== | |||
|
|
|||
| .. meta:: | |||
| :description: Learn how to migrate a Partition-Based Sync app to Flexible Sync, or open a database for Partition-Based Sync. | |||
There was a problem hiding this comment.
| :description: Learn how to migrate a Partition-Based Sync app to Flexible Sync, or open a database for Partition-Based Sync. | |
| :description: Use Atlas Device SDK to migrate a Partition-Based Sync app to Flexible Sync or open a database for Partition-Based Sync. |
For some reason it's in my head that we want the product name in the description as much as possible... but that could be me misremembering things 🙃
There was a problem hiding this comment.
That may be true generally, but I think in this case we don't necessarily want to surface PBS when people are looking for ADS info. I'm gonna omit this, but if you feel strongly about it, I can be convinced.
|
|
||
| .. _sdks-partition-based-sync-fundamentals: | ||
|
|
||
| Partition Value |
There was a problem hiding this comment.
This doesn't make sense as its own section on this page, as it's organized now. It's a concept-style section stuck between two procedure sections. I suggest moving it down to the Open a Synced DB... section
| - You add or change functionality that involves reading or writing SDK objects | ||
| - You want to implement more fine-grained control over what data you sync | ||
|
|
||
| Make these changes to convert your Partition-Based Sync client code to use |
There was a problem hiding this comment.
[nit] Feels like these includes should be ordered lists, not bullets
There was a problem hiding this comment.
Hmm. Combining this with your point below to make this a procedure with steps.
| For examples of Flexible Sync permissions strategies, including examples of | ||
| how to model data for these strategies, refer to :ref:`flexible-sync-permissions-guide`. | ||
|
|
||
| Remove and Manually Create Subscriptions |
There was a problem hiding this comment.
[future] This section is confusing since it's split out from above, which also mentions removing automatic subs and manually adding new ones. Possibly combine?
dacharyc
merged commit 97d3e5b
into
mongodb:feature-consolidated-sdk-docs
|
✨ Staging URL: https://preview-mongodbmongodb.gatsbyjs.io/realm/feature-consolidated-sdk-docs/ 🪵 Logs |
Pull Request Info - SDK Docs Consolidation
Jira ticket: https://jira.mongodb.org/browse/DOCSP-39540
Staged Page
Page Source
Note for reviewer: I've intentionally omitted some of the information that is present on some of the source pages. There's a lot of discrepancy between SDK docs re: the write copy API to copy between sync and non-synced realms. Some SDKs say you can use it with Flexible Sync, others say it only works with PBS. I started to include it on the page, but then omitted it. I think we should probably only doc it on the "Configure and Open a Synced Realm" page if it supports Flexible Sync.
The other thing is - Java and .NET have sections about opening a realm online vs. offline. I originally started to add that to this page, but decided it's outside the scope of PBS - it just happens to use PBS examples. We already have examples on the "Configure and Open a Synced Realm" page about opening a realm offline, so I think that content should only live there.
PR Author Checklist
Before requesting a review for your PR, please check these items:
feature-consolidated-sdk-docsbranch instead ofmasterNaming
.rstfiles comply with the naming guidelinesLinks and Refs
Content
Reviewer Checklist
As a reviewer, please check these items: