master README.md file out of date

NorESMhub / NorESM

Norwegian Earth System Model and Documentation

https://noresm-docs.readthedocs.io/en/latest/

Other

35 stars 74 forks source link

master README.md file out of date #501

Closed gold2718 closed 8 months ago

gold2718 commented 9 months ago

The README.md file on the master branch is out of date.

I think the documentation section should include a link to the NorESM2.1.1 release
Also, I think that the "latest" link shows all the release versions, not just NorESM2.
Should we include a section pointing to the relevant tags (e.g., release-noresm2.0.6 and release-noresm2.1.1)?

MichaelSchulzMETNO commented 8 months ago

I agree, couldnt we have the same readme in all branches? Or at least an updated one in the master? It would be nice to know where to see the 2.1 and 2.3 code for instance. Which requires to know tags and where they sit on branches. Also - couldnt we have the component tags specifically spelled out for a certain release in the release note? Its a bit tedious to seach in Externals.cfg for the tags. Once you have checked out the right NorESM tag to find the right Externals.cfg...

TomasTorsvik commented 8 months ago

I agree we should update the README.md file on the master branch, and aim to keep this updated at all time. For long-lived branches, e.g. the noresm2 branch, it can be useful to have a README.md file that provide information about the specific branch, and point to the relevant documentation. Not sure what the best approach would be for development branches, but perhaps best to minimize changes that will cause merge conflicts down the line.

I think it could be useful with a tag list for each release where we highlight (e.g. bold font) component changes from the previous release. This should be straight forward to produce when the release increments the last version digit, but perhaps not so clear for other tags (e.g. noresm2.2 does not follow chronologically from noresm2.1).

TomasTorsvik commented 8 months ago

I have updated the releases release-noresm2.1.1, release-noresm2.0.7 and release-noresm2.0.6 with tables for component tags.

TomasTorsvik commented 8 months ago

I have set the path for the documentation in the right hand side "About" to https://noresm-docs.readthedocs.io/en/latest/ (was previously pointing to noresm2 documentation). The "latest" page just gives an overview of available NorESM versions, and links to the relevant documentation.