Skip to content

docs(database): mark Windows support as development-only - #18910

Open
Adrianogba wants to merge 1 commit into
firebase:mainfrom
Adrianogba:docs/database-windows-readme
Open

Adrianogba wants to merge 1 commit into
firebase:mainfrom
Adrianogba:docs/database-windows-readme

Conversation

@Adrianogba

Copy link
Copy Markdown

Description

The stable plugins table still lists Realtime Database as N/A on Windows. Windows support shipped in firebase_database 12.4.0 (#18079), and the other Windows C++ plugins in that table (Authentication, Cloud Firestore, Cloud Storage, Core, and Remote Config) are marked (*): development only, with production unsupported.

This changes the Realtime Database Windows cell from N/A to (*).

It also fixes the duplicated product name in the firebase_database README, which read "Firebase Firebase Database" instead of "Firebase Realtime Database".

Related Issues

Fixes #18909

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]).
This will ensure a smooth and quick review process. Updating the pubspec.yaml and changelogs is not required.

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • My PR includes unit or integration tests for all changed/updated/fixed behaviors (See Contributor Guide).
  • All existing and new tests are passing.
  • I updated/added relevant documentation (doc comments with ///).
  • The analyzer (melos run analyze) does not report any problems on my PR.
  • I read and followed the Flutter Style Guide.
  • I signed the CLA.
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

  • Yes, this is a breaking change.
  • No, this is not a breaking change.

Test plan

  • The Realtime Database row in the README stable plugins table shows (*) under Windows, and the footnote under the table is unchanged.
  • The firebase_database README reads "To learn more about Firebase Realtime Database, please visit the Firebase website".

The README still lists Realtime Database as unavailable on Windows after support shipped in 12.4.0. Use the same development-only marker as the other Windows C++ plugins, and fix the duplicated "Firebase Firebase Database" wording in the plugin README.

Fixes firebase#18909

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request updates the main README.md to indicate development-only Windows support for the Realtime Database plugin, and corrects a typo in the firebase_database package's README.md. A review comment suggests adding a terminating period to the corrected sentence in the package's README for punctuation consistency.

A Flutter plugin to use the [Firebase Database API](https://firebase.google.com/docs/database/).

To learn more about Firebase Firebase Database, please visit the [Firebase website](https://firebase.google.com/products/realtime-database)
To learn more about Firebase Realtime Database, please visit the [Firebase website](https://firebase.google.com/products/realtime-database)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

low

The sentence is missing a terminating period at the end. Adding a period improves punctuation consistency.

Suggested change
To learn more about Firebase Realtime Database, please visit the [Firebase website](https://firebase.google.com/products/realtime-database)
To learn more about Firebase Realtime Database, please visit the [Firebase website](https://firebase.google.com/products/realtime-database).

This branch has not been deployed

No deployments
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.

[📚] Realtime Database Windows Support still N/A on Readme

1 participant