这是indexloc提供的服务,不要输入任何密码
Skip to content

Conversation

@erquhart
Copy link
Contributor

@erquhart erquhart commented Sep 7, 2022

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?

  • No

Metadata

Does this PR add a new Metadata feature?

  • No

GraphQL

  • No new GraphQL schema is generated

Breaking changes

  • No Breaking changes

@erquhart erquhart requested a review from a team as a code owner September 7, 2022 22:01
@hasura-bot
Copy link
Contributor

Beep boop! 🤖

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! 😎

@CLAassistant
Copy link

CLAassistant commented Sep 7, 2022

CLA assistant check
All committers have signed the CLA.

@erquhart erquhart force-pushed the erquhart/docs/dev-db-env-var branch from 28f0938 to 0a71b05 Compare September 7, 2022 22:41
@erquhart erquhart force-pushed the erquhart/docs/dev-db-env-var branch from 0a71b05 to 46878c0 Compare September 7, 2022 22:50
@seanparkross
Copy link
Contributor

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?

@hasura-bot hasura-bot closed this Sep 23, 2022
hasura-bot added a commit that referenced this pull request Sep 23, 2022
GITHUB_PR_NUMBER: 8941
GITHUB_PR_URL: #8941

PR-URL: hasura/graphql-engine-mono#5806
Co-authored-by: Shawn Erquhart <2112202+erquhart@users.noreply.github.com>
Co-authored-by: Sean Park-Ross <94021366+seanparkross@users.noreply.github.com>
GitOrigin-RevId: 51cd587f227e47a155655600ec85fa6df759c61d
@hasura-bot
Copy link
Contributor

Beep boop! 🤖

GIF

Awesome work @erquhart!

Your changes were merged successfully. All of us at Hasura ❤️ what you did.

Thanks again 🤗

@erquhart
Copy link
Contributor Author

@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.

@seanparkross
Copy link
Contributor

Hey @erquhart No worries. We took some of your suggestions and added some extra info to the projects > environments docs :)

@erquhart erquhart deleted the erquhart/docs/dev-db-env-var branch October 24, 2022 15:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants