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-37240: Add upgrade page for Flutter SDK v2.0.0 breaking changes #3196

Merged

Conversation

cbullinger
Copy link
Collaborator

@cbullinger cbullinger commented Mar 8, 2024

Pull Request Info

NOTE: This PR won't include updating the generated snippets. Code examples will be updated and snippets re-generated in DOCSP-37239 as part of test suite version upgrade.

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

  • Define a Realm Object Schema - Flutter SDK: Add new shared includes note regarding the breaking change, and update .g.dart file extensions to .realm.dart throughout page.
  • Upgrade to Flutter SDK v2.0.0: New page for migrating an app from earlier version to v2.0.0 and later.
  • Quick Start - Flutter SDK: Update .g.dart file extensions to .realm.dart throughout page.
  • Install the Flutter SDK: Add shared includes note to Update Package Version section, and update .g.dart file extensions to .realm.dart throughout page.

Reminder Checklist

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

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

Release Notes

  • Flutter SDK
    • Update any .g.dart file extensions to the new .realm.dart extension throughout the SDK documentation.
    • Install: Add note regarding the breaking change to how data model class files generate, and update "Prerequisites" section with updated version and platform requirements.
    • Realm Database/Model Data/Define a Realm Object Schema: Add note regarding the breaking change to how data model class files generate.
    • Upgrade to Flutter SDK v2.0.0: New page detailing the breaking changes to SDK version 2.0.0 and how to upgrade an app from an earlier version.

Review Guidelines

REVIEWING.md

Copy link

github-actions bot commented Mar 8, 2024

Readability for Commit Hash: f0fa565

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

Readability scores for changed documents:

  • source/sdk/flutter: Grade Level: 9.5, Reading Ease: 50.02
  • source/sdk/flutter/install: Grade Level: 5.7, Reading Ease: 70.6
  • source/sdk/flutter/upgrade-to-v2: Grade Level: 9.7, Reading Ease: 38.69
  • source/sdk/flutter/quick-start: Grade Level: 8.0, Reading Ease: 59.19
  • source/sdk/flutter/realm-database/model-data/data-types: Grade Level: 7.9, Reading Ease: 59.6
  • source/sdk/flutter/realm-database/model-data/define-realm-object-schema: Grade Level: 8.6, Reading Ease: 57.77

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 cbullinger force-pushed the docsp-37240-dart-breaking-change branch 2 times, most recently from df3d0d6 to 5da5a72 Compare March 19, 2024 14:03
@cbullinger cbullinger changed the title DOCSP-37240: Add migration page for Flutter SDK v2.0.0 breaking change DOCSP-37240: Add upgrade page for Flutter SDK v2.0.0 breaking changes Mar 19, 2024
@cbullinger cbullinger changed the base branch from dart-v2.0.0 to master March 25, 2024 15:05
Copy link

@nielsenko nielsenko left a comment

Choose a reason for hiding this comment

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

This looks good. Just a few suggestion regarding the actual PR.

However, unrelated to this PR, but spotted while reviewing:

  • Minimal flutter and dart version was downgraded to 3.10.0 and 3.0.0 in a previous release.
  • The comments about 2.17.x are obsolete, given the 3.10.0 requirement.
  • We don't support Windows on Arm, similar to Linux. We should perhaps clarify that.

source/sdk/flutter/upgrade-to-v2.txt Outdated Show resolved Hide resolved
source/sdk/flutter/upgrade-to-v2.txt Outdated Show resolved Hide resolved
@cbullinger cbullinger force-pushed the docsp-37240-dart-breaking-change branch from e24a053 to 57983c6 Compare March 26, 2024 16:52
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.

Some suggestions for adding links, otherwise LGTM! Great work :)

source/sdk/flutter/upgrade-to-v2.txt Outdated Show resolved Hide resolved
source/sdk/flutter/upgrade-to-v2.txt Outdated Show resolved Hide resolved
source/sdk/flutter/upgrade-to-v2.txt Outdated Show resolved Hide resolved
@cbullinger cbullinger merged commit 7c13422 into mongodb:master Mar 26, 2024
5 of 6 checks passed
@cbullinger cbullinger deleted the docsp-37240-dart-breaking-change branch March 26, 2024 23:06
@docs-builder-bot
Copy link

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