Closed robertjdominguez closed 1 month ago
The added content expands on the previously vague description of the .env.cloud file, offering a comprehensive table of environment variables with their purposes. This specifically addresses the usability assertion by providing clear, structured information on the role of these variables in the deployment process. Including the example with the MY_SUBGRAPH_MY_PG_CONNECTION_URI
variable and instructions for updating connection strings is particularly useful for understanding the practical application.
The usability assertion appears to be met; the changes integrate well with the rest of the documentation. The new sections complement the existing content by filling in the gaps that were previously present in the explanation of the .env.cloud file. The additional context and examples regarding environment variables and the integration with Hasura DDN ensures congruency in understanding across the entire 'Create a Project' section. Furthermore, the provision of a tip on tunneling connections provides an extra layer of utility for users working with local databases.
Hey, @robertjdominguez :wave:
Thanks for this PR! Since you changed docs files, our automated Action assigned Rob as your reviewer :tada:
Before Rob looks over the changes, we ask you to take care of a couple of items:
The docs team aims to get all PRs reviewed within 48 hours of your team doing a review in the form of a content pass. Let Rob know the level of urgency on Slack :+1:
Latest commit: |
990df63
|
Status: | ✅ Deploy successful! |
Preview URL: | https://0d727377.v3-docs-eny.pages.dev |
Branch Preview URL: | https://rob-docs-add-more-info-about.v3-docs-eny.pages.dev |
@nullxone — since we're being a bit more specific about each variable, I broke them out into a pair of tables with some context around each: https://github.com/hasura/v3-docs/pull/571/commits/932c769e6db5bd6dda5a1190ffafde81a7f8f454
Thanks for the review!
Description 📝
Adds more information about cloud env vars.
A few folks have expressed some confusion as to what is required and what isn't. As this file is generated at this point in the deployment process, we've added an admonition here to alert users to the environment variables that will be created for each connector and which are required / will be overwritten at runtime.
Quick Links 🚀
Updated section
Assertion Tests 🤖
A user will understand what's happening in the .env.cloud file.