Skip to content

DOCSP-39924: Update eligible SDKs with collections in mixed info #3293

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

Merged
merged 5 commits into from
Jun 17, 2024

Conversation

cbullinger
Copy link
Collaborator

@cbullinger cbullinger commented Jun 11, 2024

Pull Request Info

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

For each of the following SDK pages:

  • Define data model: add Model Unstructured Data section to define data model page
  • Mixed data property: update with support for holding lists & dicts, and add Collections as Mixed subsection

Kotlin (v2.0.0):

.NET (v12.22.0):

Node.js (v12.9.0):

React Native (v12.9.0):

Swift (v10.15.0):

Release Notes

Kotlin SDK

  • Realm > Model Data > Define an Object Model: Add new "Define Unstructured Data" section outlining support for Collections as Mixed feature.
  • Realm > Model Data > Supported Data Types: Update RealmAny section to indicate support for holding lists and dictionaries, and add new "Mixed Collections" section.

.NET SDK

  • Model Data > Define an Object Model: Add new "Model Unstructured Data" section outlining support for Collections as Mixed feature.
  • Model Data > Supported Data Types > RealmValue: Update page to indicate support for holding lists and dictionaries, and add new "Mixed Collections" section.

Node.js SDK

  • Model Data > Define an Object Model: Add new "Model Unstructured Data" section outlining support for Collections as Mixed feature.
  • Model Data > Supported Data Types > Mixed: Update page to indicate support for holding lists and dictionaries, and add new "Mixed Collections" section.

React Native SDK

  • Model Data > Define an Object Model: Add new "Define Unstructured Data" section outlining support for Collections as Mixed feature.
  • Model Data > Supported Data Types > Mixed: Update page to indicate support for holding lists and dictionaries, and add new "Mixed Collections" section.

Swift SDK

  • Model Data > Define an Object Model: Add new "Model Unstructured Data" section outlining support for Collections as Mixed feature.
  • Model Data > Supported Types: Update AnyRealmValue section to indicate support for holding lists and dictionaries, and add new "Mixed Collections" section.

Copy link

github-actions bot commented Jun 11, 2024

Readability for Commit Hash: 8dd3fbd

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

Readability scores for changed documents:

  • source/sdk/node/model-data: Grade Level: 10.7, Reading Ease: 46.67
  • source/sdk/node/model-data/define-a-realm-object-model: Grade Level: 8.8, Reading Ease: 57.27
  • source/sdk/node/model-data/data-types/mixed: Grade Level: 6.3, Reading Ease: 68.97
  • source/sdk/kotlin/realm-database/schemas/define-realm-object-model: Grade Level: 10.2, Reading Ease: 47.99
  • source/sdk/kotlin/realm-database/schemas/supported-types: Grade Level: 10.1, Reading Ease: 43.09
  • source/sdk/flutter/realm-database/model-data/define-realm-object-schema: Grade Level: 8.5, Reading Ease: 57.87
  • source/sdk/flutter/realm-database/model-data/data-types: Grade Level: 7.9, Reading Ease: 59.4
  • source/sdk/dotnet/model-data/define-object-model: Grade Level: 9.5, Reading Ease: 55.34
  • source/sdk/dotnet/model-data/data-types/realm-value: Grade Level: 9.7, Reading Ease: 49.52
  • source/sdk/react-native/model-data: Grade Level: 11.1, Reading Ease: 45.66
  • source/sdk/react-native/model-data/define-a-realm-object-model: Grade Level: 8.7, Reading Ease: 57.47
  • source/sdk/react-native/model-data/data-types/mixed: Grade Level: 7.3, Reading Ease: 66.44
  • source/sdk/swift/model-data: Grade Level: 9.8, Reading Ease: 49.11
  • source/sdk/swift/model-data/object-models: Grade Level: 9.6, Reading Ease: 49.72
  • source/sdk/swift/model-data/supported-types: Grade Level: 9.5, Reading Ease: 49.92

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.

@cbullinger
Copy link
Collaborator Author

Autobuilder error is caused by an unrelated file; fix is in PR-3288

@cbullinger cbullinger added the Add to consolidation feature branch PR merged after cutting the consolidation feature branch, so cherry-pick to the feature branch. label Jun 11, 2024
@cbullinger
Copy link
Collaborator Author

Note to reviewer: open to suggestions on where the new Model Unstructured Data sections might live (unsurprisingly, it's different from SDK to SDK 😉 )

Copy link
Collaborator

@krollins-mdb krollins-mdb left a comment

Choose a reason for hiding this comment

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

Nice work, @cbullinger! Thanks for getting this all together. Overall, it looks great! A couple things to look at:

High-level things:

  • For Node.js, React Native, and Swift, I think it would make sense to move the content to the "Define and Object Model" page. We could have a bit of info + link on the Model Data landing pages, but I think we talked about how those aren't often used.
  • I think you need to finish filling out the release notes section of the PR description

My in-line comments are mostly pretty minor.

@cbullinger cbullinger force-pushed the docsp-39924-unstructured-data branch from 7a5d08f to 3283bc3 Compare June 17, 2024 13:31
@cbullinger cbullinger merged commit 1352bb4 into mongodb:master Jun 17, 2024
6 checks passed
@cbullinger cbullinger deleted the docsp-39924-unstructured-data branch June 17, 2024 13:50
@docs-builder-bot
Copy link

dacharyc pushed a commit that referenced this pull request Jun 24, 2024
## Pull Request Info

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

For each of the following SDK pages: 
- Define data model: add `Model Unstructured Data` section to define
data model page
- Mixed data property: update with support for holding lists & dicts,
and add `Collections as Mixed` subsection

**Kotlin (v2.0.0):** 
- [Define an Object Model - Kotlin
SDK](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-39924-unstructured-data/sdk/kotlin/realm-database/schemas/define-realm-object-model/#model-unstructured-data)
& [Supported Data Types - Kotlin
SDK](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-39924-unstructured-data/sdk/kotlin/realm-database/schemas/supported-types/#realmany--mixed-)

**.NET (v12.22.0):** 
- [Define an Object Model - .NET
SDK](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-39924-unstructured-data/sdk/dotnet/model-data/define-object-model/#model-unstructured-data)
& [RealmValue - .NET
SDK](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-39924-unstructured-data/sdk/dotnet/model-data/data-types/realm-value/)

**Node.js (v12.9.0):** 
- [Define an Object Model - Node.js
SDK](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-39924-unstructured-data/sdk/node/model-data/define-object-model/#model-unstructured-data)
& [Mixed - Node.js
SDK](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-39924-unstructured-data/sdk/node/model-data/data-types/mixed/#nested-collections-of-mixed)

**React Native (v12.9.0):** 
- [Define an Object Model - React Native
SDK](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-39924-unstructured-data/sdk/react-native/model-data/define-object-model/#model-unstructured-data)
& [Mixed - React Native
SDK](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-39924-unstructured-data/sdk/react-native/model-data/data-types/mixed/#nested-collections-of-mixed)

**Swift (v10.15.0):** 
- [Define an Object Model - Swift
SDK](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-39924-unstructured-data/sdk/swift/model-data/object-models/#model-unstructured-data)
& [Supported Types - Swift
SDK](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-39924-unstructured-data/sdk/react-native/model-data/data-types/mixed/)

## Release Notes

**Kotlin SDK** 
- Realm > Model Data > Define an Object Model: Add new "Define
Unstructured Data" section outlining support for *Collections as Mixed*
feature.
- Realm > Model Data > Supported Data Types: Update ``RealmAny`` section
to indicate support for holding lists and dictionaries, and add new
"Mixed Collections" section.

**.NET SDK** 
- Model Data > Define an Object Model: Add new "Model Unstructured Data"
section outlining support for *Collections as Mixed* feature.
- Model Data > Supported Data Types > RealmValue: Update page to
indicate support for holding lists and dictionaries, and add new "Mixed
Collections" section.

**Node.js SDK** 
- Model Data > Define an Object Model: Add new "Model Unstructured Data"
section outlining support for *Collections as Mixed* feature.
- Model Data > Supported Data Types > Mixed: Update page to indicate
support for holding lists and dictionaries, and add new "Mixed
Collections" section.

**React Native SDK** 
- Model Data > Define an Object Model: Add new "Define Unstructured
Data" section outlining support for *Collections as Mixed* feature.
- Model Data > Supported Data Types > Mixed: Update page to indicate
support for holding lists and dictionaries, and add new "Mixed
Collections" section.

**Swift SDK** 
- Model Data > Define an Object Model: Add new "Model Unstructured Data"
section outlining support for *Collections as Mixed* feature.
- Model Data > Supported Types: Update ``AnyRealmValue`` section to
indicate support for holding lists and dictionaries, and add new "Mixed
Collections" section.
@dacharyc dacharyc removed the Add to consolidation feature branch PR merged after cutting the consolidation feature branch, so cherry-pick to the feature branch. label Jun 24, 2024
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