graphql-engine
graphql-engine copied to clipboard
hasura
docs: add data source config explanation for local dev
Description
An unclear instruction in the docs caused a couple days' confusion for me. A helpful Hasurian helped me out with an explanation. This PR is a proposal to add the clarity I was missing when transitioning from cloud-only to a local development setup.
Feel free to turn this down if you feel it isn't helpful or overkill :)
Catalog upgrade
Does this PR change Hasura Catalog version?
- [x] No
Metadata
Does this PR add a new Metadata feature?
- [x] No
GraphQL
- [x] No new GraphQL schema is generated
Breaking changes
- [x] No Breaking changes
Beep boop! :robot:
Hey @erquhart, thanks for your PR!
One of my human friends will review this PR and get back to you as soon as possible.
Stay awesome! :sunglasses:
Hi @erquhart Thanks for the PR! We appreciate it.
Couple things. The env var PG_DATABASE_URL is not a Hasura convention but merely a choice of name made by the authors of the example docker-compose.yaml example file. This can then be used in the installation metadata to connect to a database. For this reason we're reluctant to specify that this should be the name for this value in this doc because it actually might be something else if the user did not start with our example docker-compose.yaml.
However we do want to make this doc more clear if you (and others) may have been having issues with clarity.
This line in your edits: You can skip the steps involving connecting a database, as you'll be applying metadata from your cloud database in a later step. I think is useful and we can incorporate it.
This line in the original: Make sure that the ENV variable for database connection in your local setup is same as that in your Cloud project. I also think could be clarified to something like: Make sure that the ENV variable name for database connection in your local setup is the same as that in your Cloud project so that your database connection metadata will still work and not need to be updated. The value of this variable will obviously be updated to point to your local database.
Thoughts?
Beep boop! :robot:
Awesome work @erquhart!
Your changes were merged successfully. All of us at Hasura :heart: what you did.
Thanks again :hugs:
@seanparkross so sorry I meant to come back and address your comments - I'm not seeing any changes on your docs but let me know if there are still edits to make.
Hey @erquhart No worries. We took some of your suggestions and added some extra info to the projects > environments docs :)