Release notes workflow - Githubissues

Deltares / Fm2Prof

https://deltares.github.io/Fm2Prof/

GNU General Public License v3.0

2 stars 0 forks source link

Release notes workflow #88

Open kdberends opened 5 months ago

kdberends commented 5 months ago

Issue

Currently release notes are maintained on the "releases" tab and in docs/Changelog.md. However, our users are used to "release notes" and PDF documents.

Proposed fix

Rename "docs/CHANGELOG.MD" to "release_notes.md"
update mkdocs.yml to reflect this change in file name
Edit Github CI workflow to compile release_notes.md to PDF (e.g. using a pandoc action).

JacoStout commented 5 months ago

I (Jaco) would like to follow D-HYDRO Release notes:

a cover (Dutch Delta Systems)
an Introduction with Release contents (standard text / description of "What FM2prof is") and Documentation list
followed by Release summary (a dump of the CHANGELOG.md)

JacoStout commented 5 months ago

I (Jaco) have a cover for the Rel.Notes (attached) FM2prof-RN.pdf

rhutten commented 5 months ago

@JacoStout, Could you further elaborate on "an Introduction with" ? Are there already markdown files with "What is FM2prof"? And what do you want to include in the documentation list?