Environment variables need to be properly documented

[tiberiuichim]

https://github.com/plone/volto/blob/d3865b3ac9e5c1213058373e6ecf5422060d7ab0/src/config/index.js#L91-L93

[tiberiuichim]

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

[KIET7UKE]

Hey @tiberiuichim , I'm interested to work on this. Can you please explain to me in easy, what to change?

[mjavedcoder]

Hi @tiberiuichim, I am Qasim Javed a student of Computing and in the final year of my degree . I have just started looking to contribute for open source . At this stage i am leaning web development and already made many projects on JavaScript and React. I am interested to work on this issue,Can you please help me in the understanding of this issue and assign it to me ?

Your response will be highly appreciated,

Thanks

[stevepiercy]

@KIET7UKE @Hello-Qasim please see Volto and general contributing guidelines.

• https://6.docs.plone.org/volto/developer-guidelines/contributing.html
• https://6.docs.plone.org/contributing/index.html#making-contributions-on-github

I have also updated the issue description, and will hide both of your comments as "resolved" to reduce clutter. If you are still not clear on what needs to be done and how we expect contributors to work in Plone, please ask specific questions. Thank you!

[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?

[AAYUSH-droid]

hey! i would like to contribute can i get assigned!

[stevepiercy]

@AAYUSH-droid see https://github.com/plone/volto/issues/4581#issuecomment-1484224952

[hasnaat-iftikhar]

Can I start working on that issue?

[stevepiercy]

@hasnaat-iftikhar please read and follow Contributing to Plone and First-time contributors.

[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