Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release notes workflow #88

Open
kdberends opened this issue Jun 10, 2024 · 3 comments
Open

Release notes workflow #88

kdberends opened this issue Jun 10, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@kdberends
Copy link
Member

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

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

JacoStout commented Jun 11, 2024

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
Copy link

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

@rhutten
Copy link

rhutten commented Jun 19, 2024

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

@kdberends kdberends added the documentation Improvements or additions to documentation label Sep 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants