docs: add a Data Connect guide and link it from the README#3724
Open
armando-navarro wants to merge 1 commit into
Open
docs: add a Data Connect guide and link it from the README#3724armando-navarro wants to merge 1 commit into
armando-navarro wants to merge 1 commit into
Conversation
Add docs/data-connect.md describing the Data Connect secondary entry point, following the same shape as the other product guides: a short intro, the dependency-injection setup (provideDataConnect/getDataConnect with a connector config, then inject(DataConnect)), and the wrap-the-SDK note. Add the Data Connect entry to the README feature table in its alphabetical slot after Cloud Storage, and re-flow the table into even two-column rows, which also fixes the previously lopsided final row. This supersedes angular#3673, which added the README entry but linked it to a docs/data-connect.md that did not exist (a dead link) and placed the row out of alphabetical order. Credit to @maneesht for adding the entry and flagging the gap. Firebase now brands this product "Firebase SQL Connect"; the guide keeps "Data Connect" as the primary name to match the @angular/fire/data-connect entry point and notes the new branding.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a Data Connect guide and wires it into the README feature table.
Data Connect support already shipped in the library (the
ng addschematics generate its config, #3638 and #3714), but there was no guide for it, and #3636 asked for exactly that. #3673 added a README table entry for Data Connect, but the entry linked to adocs/data-connect.mdthat did not exist (a dead link) and sat out of alphabetical order. This carries that contribution forward: it adds the missing guide and places the entry correctly. Credit to @maneesht for adding the entry and surfacing the gap.What's here
docs/data-connect.md: a new guide following the same shape as the other product guides (intro, dependency-injection setup withprovideDataConnect/getDataConnectand a connector config, theninject(DataConnect), and the standard "AngularFire wraps the Firebase JS SDK" note).README.md: the Data Connect entry, placed alphabetically after Cloud Storage, with the feature table re-flowed into even two-column rows (this also fixes the previously lopsided final row).Notes
@angular/fire/data-connectentry point and theDataConnectclass, and notes the new branding inline.@firebase/data-connecttype definitions:getDataConnect(options: ConnectorConfig)is a real overload, andConnectorConfigis{ location, connector, service }.Fixes #3636