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-38601: Update Conflict Resolution with info on dictionary keys #758

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

cbullinger
Copy link
Collaborator

Pull Request Info

Jira ticket: https://jira.mongodb.org/browse/DOCSP-38601

  • Conflict Resolution: Add new "Dictionaries" section to clarify how Sync handles conflicts with dictionary key updates

Reminder Checklist

Before merging your PR, make sure to check a few things.

  • Did you tag pages appropriately?
    • genre
    • programming_language
    • meta.keywords
    • meta.description
  • Describe your PR's changes in the Release Notes section
  • Create a Jira ticket for related docs-realm work, if any

Release Notes

  • Device Sync
    • Technical Details/Conflict Resolution: Add new "Dictionaries" section to clarify how Device Sync handles conflicts with dictionary keys.

Review Guidelines

REVIEWING.md

Copy link
Collaborator

@dacharyc dacharyc left a comment

Choose a reason for hiding this comment

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

I think this is broadly fine as-is, but have a couple of non-blocking suggestions that you might consider.

@@ -4,17 +4,19 @@
Conflict Resolution
===================

.. default-domain:: mongodb
.. meta::
:description: A high-level overview of how Atlas Device Sync resolves synced data conflicts.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I might instead position this benefit-first, as conflict resolution is one of the reasons to use Realm/Device Sync. Maybe something like:

Suggested change
:description: A high-level overview of how Atlas Device Sync resolves synced data conflicts.
:description: Learn about how Atlas Device Sync automatically resolves synced data conflicts, or how to build custom conflict resolution rules.

Dictionaries
~~~~~~~~~~~~

Generally, dictionary conflicts are handled similarly to lists. However, there
Copy link
Collaborator

Choose a reason for hiding this comment

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

We're referring to how conflicts are handled in lists, but we don't have a "Lists" section that spells this out. Instead, the information is scattered throughout the page. I might skip the intro sentence here and go straight to:

Device Sync considers the removal of a dictionary key to be an update, rather than a deletion. As a result...

Alternately, we could add a List section that spells out list details.

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.

None yet

2 participants