DOCSP-33418 Remove PBS mentions form the docs #634
Conversation
lindseymoore
force-pushed
the
DOCSP-34418
branch
from
fca0de3 to
c117a60
Compare
There was a problem hiding this comment.
Overall LGTM! Nice work! Just a couple of small nits, including one place where we can't delete the section outright because the product links to it in the UI.
I see your note about ignoring the changes to release notes. Would you like help removing that file from this PR?
| ~~~~~~~~~ | ||
|
|
||
| Atlas Device Sync has two sync modes: Flexible Sync and the older | ||
| Partition-Based Sync. We recommend using Flexible Sync. For information about |
There was a problem hiding this comment.
I don't think we can delete this section entirely, but we should update it. When you go to enable Sync, the App Services UI still shows Partition-Based Sync, although it is grayed out. The UI says:
Partition Based sync has been deprecated and is disallowed for new Sync configurations. Learn more about the differences between Partition Based Sync and Flexible Sync
And the link goes directly to this section in the docs.
I think we should leave this section, but update it to copy the language in the UI and say something like:
Atlas Device Sync has two sync modes: Flexible Sync and the older Partition-Based Sync. Partition-Based Sync has been deprecated and is disallowed for new Sync configurations. If you have an existing app that uses Partition-Based Sync, you can migrate to Flexible Sync. For more information, refer to :ref:`realm-sync-migrate-modes`.
There was a problem hiding this comment.
Changed! As the UI call out says to go to this page for more information on the differences, I added link to PBS page for more context as well if anyone is interested to learn more. Let me know what you think.
There was a problem hiding this comment.
Since Partition-Based Sync is deprecated, and is disallowed for new apps, I don't think we need to link to it from here. This page is mainly for people who are setting up Sync for the first time, and I don't think we need to send them out to another page to read about a sync mode they can't even use. I think the wording in the UI is unfortunate for the same reason - if we're not allowing people to create new PBS apps, the differences between PBS and FS don't matter. FS is the only Sync they can use.
There was a problem hiding this comment.
I agree! I will remove. I wish the UI text could be changed though. Is there a way to file a ticket for this?
lindseymoore
force-pushed
the
DOCSP-34418
branch
from
1acf577 to
d3615cd
Compare
| ~~~~~~~~~ | ||
|
|
||
| Atlas Device Sync has two sync modes: Flexible Sync and the older | ||
| Partition-Based Sync. We recommend using Flexible Sync. For information about |
There was a problem hiding this comment.
Since Partition-Based Sync is deprecated, and is disallowed for new apps, I don't think we need to link to it from here. This page is mainly for people who are setting up Sync for the first time, and I don't think we need to send them out to another page to read about a sync mode they can't even use. I think the wording in the UI is unfortunate for the same reason - if we're not allowing people to create new PBS apps, the differences between PBS and FS don't matter. FS is the only Sync they can use.
|
✨ Staging URL: https://preview-mongodbmongodb.gatsbyjs.io/atlas-app-services/master/ 🪵 Logs |
* DOCSP-34366 Remove PBS mentions form docs * add relationship note to pbs page * fix include * Re add sync type section * remove link to PBS on sync settings
Pull Request Info
Jira ticket: https://jira.mongodb.org/browse/DOCSP-34418
Staged changes:
Reminder Checklist
Before merging your PR, make sure to check a few things.
Release Notes
Other
Review Guidelines
REVIEWING.md