Document environment variables #5735
Conversation
✅ Deploy Preview for volto ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for plone-components canceled.
|
|
@Manas-Kenge please hold on this pull request, per #4581 (comment). |
|
Ok, no problem. |
|
@Manas-Kenge I overhauled the file in #5736. You may rebase your work on |
| `process.env.RAZZLE_INTERNAL_API_PATH`: Used to specify the path to an internal API that the server-rendered application should use. | ||
|
|
||
| `process.env.RAZZLE_PROXY_REWRITE_TARGET`: Used to specify the target URL for a proxy server. | ||
|
|
There was a problem hiding this comment.
All of these environment variables should follow the existing pattern as the glossary items below.
I also don't know whether the prefix process.env. is necessary. Perhaps a Volto core maintainer knows?
Finally, do these belong under this heading or another? Again, perhaps a Volto core maintainer knows?
There was a problem hiding this comment.
@stevepiercy @Manas-Kenge process.env. is not part of the name of the environment variable. It's how the variable is accessed in Node. It doesn't make sense to use it here, which is explaining variables that can be set, not how to write code that uses them.
Co-authored-by: Steve Piercy <[email protected]>
|
I referred the Razzle documentation https://razzlejs.org/docs/environment-variables for this. |
|
@Manas-Kenge The Razzle documentation is describing environment variables that are set automatically by Razzle and can be accessed by application code. Our docs are trying to describe environment variables that can be set manually from outside the application to influence how it runs. |
stevepiercy
dismissed
their stale review
docs format looks good, content needs review for accuracy
Fixes #4581 #5319
@tiberiuichim I updated the docs as per my understanding, was I supposed to create a separate section for it? I looked at the Razzle docs for reference.