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

Availability of release notes #181

Open
kkaempf opened this issue Dec 6, 2024 · 2 comments
Open

Availability of release notes #181

kkaempf opened this issue Dec 6, 2024 · 2 comments
Labels
area/documentation Improvements or additions to documentation area/release

Comments

@kkaempf
Copy link
Contributor

kkaempf commented Dec 6, 2024

Looking at https://turtles.docs.rancher.com I fail to see release notes for the various versions.

Or we start writing blog posts for every release like Kubewarden does

@furkatgofurov7
Copy link
Contributor

Release notes are published in Turtles Github repository as part of each release: https://github.com/rancher/turtles/releases/tag/v0.14.0 and not as part of the Turtles book which is a different repo. Also from my point of view and looking at upstream, I can't think of a project that refers/publishes to release notes from the documentation.

@kkaempf
Copy link
Contributor Author

kkaempf commented Dec 16, 2024

I'm not asking for release notes as part of the documentation. I am asking for an easy way to find details about a release, ideally starting from the main documentation page.
A single line like "Latest release 0.14, see here for details".

I'd like to see human readable (which most likely implies "written by a human") release notes, that explain the (often cryptic) one-line commit messages on the GH releases page.

Release notes should esp. explain

  • why this release happened and why I should update
  • any behaviour or configuration changes
  • for new features: why could this be important for me and how I take advantage of this feature

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation area/release
Development

No branches or pull requests

2 participants