ESMValGroup / ESMValCore

ESMValCore: A community tool for pre-processing data from Earth system models in CMIP and running analysis scripts.
https://www.esmvaltool.org
Apache License 2.0
42 stars 38 forks source link

Improve the ESMValCore release documentation #2399

Open ehogan opened 4 months ago

ehogan commented 4 months ago

Is your feature request related to a problem? Please describe.

@chrisbillowsMO and I are currently working on the ESMValCore release, see #2389. There are a few items not detailed in the ESMValCore documentation: Making a release instuctions that might be worth adding:

We recognise that a lot of this information already exists but we did struggle to understand the process in places. The order confused as at times and some of the specific we found out from conversation would have helped us a lot if they were included in the documentation.

We'd have found it easier to follow overall if there were perhaps more short, individual pages each focused on a clearly delineated individual step.

Also, it would've been useful if there was a concise outline very early in the instructions that outlined every time sensitive step.

As specific suggestions, we'd first propose it might be helpful if this page offers the release a brief, high level overview of the entire process, including:

When the "feature freeze" date has been determined:

At least two weeks before the proposed "feature freeze" date:

Would you be able to help out?

Yes 😊