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-37133: Collections in Mixed data type #715

Merged

Conversation

cbullinger
Copy link
Collaborator

@cbullinger cbullinger commented Mar 29, 2024

Pull Request Info

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

Misc formatting & style 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

  • Configure and Update Your Data Model
    • Create a Data Model: Updates for readability and clarity.
    • Data Model Mapping:
      • Add new "Mixed Properties" section.
      • Update "Example" section to demonstrate nested collections of mixed data.
      • Update "Geospatial" section with content moved from Schema Types page.

Define a Data Model

  • Schemas/Enforce a Schema: Update page title to "Define & Enforce a Schema".
  • Schemas/Schema Types:
    • Update "Mixed" data type section to reflect new support for arrays and dictionaries in Apps created after May 22, 2024.
    • Add new "Counter" section to "Realm Database Types" to document counter data types and specify which SDKs support them.
    • Move Device Sync-specific geospatial query content to Data Model Mapping page.

Technical Details

  • Conflict Resolution: Add new "Nested Collections" section.

Review Guidelines

REVIEWING.md

@cbullinger cbullinger force-pushed the docsp-37133-sync-collections-in-mixed branch from c2ac2d6 to b219945 Compare March 29, 2024 17:08
@cbullinger cbullinger marked this pull request as ready for review March 29, 2024 17:47
Copy link

@tkaye407 tkaye407 left a comment

Choose a reason for hiding this comment

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

Generally looks good to me! Ill let Niharika give the official 👍 though as she is leading the project

source/includes/note-collections-in-mixed-sync.rst Outdated Show resolved Hide resolved
source/schemas/types.txt Show resolved Hide resolved
source/sync/data-model/data-model-map.txt Outdated Show resolved Hide resolved
source/schemas/types.txt Outdated Show resolved Hide resolved
@cbullinger cbullinger added the DO NOT MERGE Pending feature release, review, or discussion label Apr 1, 2024
Copy link
Collaborator Author

@cbullinger cbullinger left a comment

Choose a reason for hiding this comment

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

@niharika01 this PR includes some unrelated updates (formatting cleanup and corrections I made while I was working in these pages), so not everything will need your review. I've left comments to indicate the updates specific to collections in mixed project that I'd like you to take a look at.

@cbullinger cbullinger force-pushed the docsp-37133-sync-collections-in-mixed branch from e277506 to d9ff60c Compare April 1, 2024 15:01
source/schemas/types.txt Show resolved Hide resolved
source/sync/data-model/data-model-map.txt Outdated Show resolved Hide resolved
Copy link

@niharika01 niharika01 left a comment

Choose a reason for hiding this comment

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

LGTM 🚀
Thank you!

Copy link
Collaborator

@lindseymoore lindseymoore left a comment

Choose a reason for hiding this comment

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

A few small things!
Larger question: Should the 'Realm Object Schema' be referred to as 'Atlas Device SDK Object Schema'? I see you switch between using the terms depending on the page; should probably be standardized.

source/includes/note-collections-in-mixed-sync.rst Outdated Show resolved Hide resolved
source/schemas/enforce-a-schema.txt Outdated Show resolved Hide resolved
source/schemas/relationships.txt Outdated Show resolved Hide resolved
source/schemas/relationships.txt Outdated Show resolved Hide resolved
source/schemas/types.txt Show resolved Hide resolved
source/sync/data-model/data-model-map.txt Outdated Show resolved Hide resolved
source/sync/data-model/data-model-map.txt Outdated Show resolved Hide resolved
source/sync/data-model/data-model-map.txt Outdated Show resolved Hide resolved
source/includes/note-collections-in-mixed-sync.rst Outdated Show resolved Hide resolved
source/sync/data-model/sync-schema-overview.txt Outdated Show resolved Hide resolved
Co-authored-by: lindseymoore <71525840+lindseymoore@users.noreply.github.com>
@cbullinger cbullinger requested a review from lindseymoore April 8, 2024 14:26
Copy link
Collaborator

@lindseymoore lindseymoore left a comment

Choose a reason for hiding this comment

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

Overall, LGTM, and thanks for making these updates!
Not sure why some of the :manual: links are giving 404s on my end. If it's working on your end, perhaps just do a quick check to make sure they're working once deployed.

source/schemas/relationships.txt Show resolved Hide resolved
source/schemas/types.txt Show resolved Hide resolved
source/schemas/types.txt Show resolved Hide resolved
source/sync/data-model/data-model-map.txt Outdated Show resolved Hide resolved
@cbullinger cbullinger force-pushed the docsp-37133-sync-collections-in-mixed branch 2 times, most recently from f24d5c6 to 072a715 Compare April 24, 2024 12:55
@cbullinger cbullinger force-pushed the docsp-37133-sync-collections-in-mixed branch from 072a715 to 22c8874 Compare April 24, 2024 12:57
@cbullinger cbullinger removed the DO NOT MERGE Pending feature release, review, or discussion label May 31, 2024
@@ -0,0 +1,23 @@
.. note:: Collections in Mixed fields supported in Apps created after May 22, 2024

App Services Apps created *after* May 22, 2024 can store collections

Choose a reason for hiding this comment

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

Thank you for updating this! I think technically this was out in prod on May 29th but I'll defer to @tkaye407 since May 22nd was the official release date

@cbullinger cbullinger merged commit 824fc51 into mongodb:master Jun 3, 2024
4 checks passed
@cbullinger cbullinger deleted the docsp-37133-sync-collections-in-mixed branch June 3, 2024 11:55
@docs-builder-bot
Copy link

MongoCaleb pushed a commit to MongoCaleb/docs-app-services that referenced this pull request Jun 3, 2024
* Initial draft

* Fix formatting

* Fix broken link

* Update to reference 'document'

* Update note

* Fix list formatting

* Apply review feedback

* Apply suggestions from code review

Co-authored-by: lindseymoore <71525840+lindseymoore@users.noreply.github.com>

* Update with date of app support

* Update supported SDK versions

* Add finalized date to note

* Update source/sync/data-model/data-model-map.txt

* Update source/schemas/relationships.txt

---------

Co-authored-by: lindseymoore <71525840+lindseymoore@users.noreply.github.com>
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.

5 participants