artsy / README

:wave: - The documentation for being an Artsy Engineer
Creative Commons Attribution 4.0 International
1.1k stars 120 forks source link

doc: add documentation around adding new config variables #451

Closed fladson closed 2 years ago

fladson commented 2 years ago

Adding some more documentation about environment variables. For more context, see thread.

mc-jones commented 2 years ago

Thanks for this @fladson! So do want to draw a distinction between the development environment and the staging and production runtime environment. For development, the env.shared should be sufficient. But if you want to test those changes in staging or see them in production, then that is when you need to use hokusai ... env set .... This is mentioned here: https://zoom.us/j/93825693217, so wondering if better to note as a follow up and link to the existing doc? What do. you think?

fladson commented 2 years ago

Thanks for this @fladson! So do want to draw a distinction between the development environment and the staging and production runtime environment. For development, the env.shared should be sufficient. But if you want to test those changes in staging or see them in production, then that is when you need to use hokusai ... env set .... This is mentioned here: https://zoom.us/j/93825693217, so wondering if better to note as a follow up and link to the existing doc? What do. you think?

Thanks @mc-jones for the "review", now I realised that this refers only to the local environment, sorry.

I guess you meant this doc, right?

I updated the change to what you suggested.

mc-jones commented 2 years ago

Sorry about the delayed merge on this!