Update README.md to include Firebase Data Connect - #3673
Conversation
armando-navarro
left a comment
armando-navarro
left a comment
There was a problem hiding this comment.
Hi @maneesht - thanks for this, and sorry it sat so long. I've recently taken over maintenance and I'm working through the PR backlog. Data Connect absolutely belongs in the README's feature table, so I'd like to get this in. Two things need fixing first:
The link target doesn't exist
docs/data-connect.md isn't in the repo, so the heading would link to a 404. Until an AngularFire-specific docs page exists, could you point it at the official Data Connect docs (https://firebase.google.com/docs/data-connect) instead? (A docs/data-connect.md in the style of the other feature pages would be even better, if you're up for it - but I won't block on that.)
The new cell lands in the wrong row
The feature table is two columns, and this inserts a third into the Cloud Firestore / Cloud Functions row, which renders a strange-looking 3rd row that can only be seen by scrolling horizontally. The last row currently has an empty slot next to Vertex AI - moving the Data Connect cell there keeps the table balanced.
Happy to take care of it
Happy to take this over and make both tweaks myself if you'd rather - just say the word. Otherwise I'll merge once they're in.
|
Hi @maneesht, just checking in on this one. I'd still like to get Data Connect into the README. The only things between this and merge are the two small tweaks from my review above: pointing the link at the official Data Connect docs (since If you have a few minutes to push those, I'll merge. If you'd rather hand it off, I'm happy to make both changes myself and get it in, just say the word. Either way works. |
armando-navarro
added
comp: docs
|
Thanks for this, @maneesht, and for flagging that Data Connect was missing from the docs. I've opened #3724, which carries your README entry forward and adds the |
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 #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.
2 participants
No description provided.