Environment variables need to be properly documented

[tiberiuichim]

volto/src/config/index.js

Lines 91 to 93 in d3865b3

	process.env.RAZZLE_DEV_PROXY_API_PATH ||
	process.env.RAZZLE_INTERNAL_API_PATH ||
	process.env.RAZZLE_API_PATH ||

[tiberiuichim]

Follow the pattern of documenting environment variables as shown in https://6.docs.plone.org/volto/configuration/environmentvariables.html

[harshlancer]

As these are runtime variable and as the docs suggest these should be documented like
yarn build && RAZZLE_API_PATH=https://plone.org yarn start:prod
Right?

[Akshat2Jain]

Hey @stevepiercy can you guide me a little in this?

[stevepiercy]

@Akshat2Jain sorry, I don't know. I would suggest you look at what @tiberiuichim posted and referenced, and try to figure it out from there, and if it is still not clear, then ask him as he created this issue.

[stevepiercy]

I think we need to overhaul this page before we let contributors move forward with a PR. Environment variables

For example, we don't need to refer to obsolete things here, only current things. The obsolete stuff goes into the upgrade guide.

I also would like to have settings in a sorted definition list, instead of headings for each. We can group together some settings in categories under a heading as needed.

@tiberiuichim what do you think?

[tiberiuichim]

@stevepiercy +1 on your proposal