Update the README of Data Connect to help developers onboarding #13198
Conversation
This file contains 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
charlotteliang
requested review from
cherylEnkidu,
andrewheard and
aashishpatil-g
|
First version, will add SDK part later. |
|
Not sure the check is valid for the PR. |
|
You can ignore the CI failure. It will be fixed by the next rebase or merge from |
cherylEnkidu
requested changes
Jul 2, 2024
FirebaseDataConnect/README.md
Outdated
| Here's a quick rundown of steps to get you started. Learn more about details at the official [Getting Started documentation](https://firebase.google.com/docs/data-connect/quickstart). | ||
|
|
||
| ### 1. Create a new Data Connect service and Cloud SQL instance. | ||
| * Go to Firebase Console and select Firebase Data Connect from LeftNav bar to create a new Data Connect service and a Cloud SQL instance. You have to be in Blaze plan and you can view the details of pricing at https://firebase.google.com/pricing. |
There was a problem hiding this comment.
LeftNav seems a little bit too technical, would it be better if we just call it something like left navigation bar?
FirebaseDataConnect/README.md
Outdated
| ### 3. Set up VSCode | ||
| You will need VS Code and its Firebase extension (VS Code extension) to automatically generate Swift code for your queries. | ||
| * Install VS Code | ||
| * Download the [extension](https://firebasestorage.googleapis.com/v0/b/firemat-preview-drop/o/vsix%2Ffirebase-vscode-latest.vsix?alt=media) and drag it into the "Extensions" Left Nav bar for installation. |
There was a problem hiding this comment.
Left Nav same as above
FirebaseDataConnect/README.md
Outdated
| ``` | ||
| mkdir fdc | ||
| ``` | ||
| * Open VS Code from FDC folder |
There was a problem hiding this comment.
Suggest change to something like: open VS Code from the folder you would like to have firebase configuration.
There was a problem hiding this comment.
Thats the folder we suggested to make, maybe I will adjust the above step to: create a folder you'd like to have firebase configuration
cherylEnkidu
approved these changes
Jul 2, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
No description provided.