ITISFoundation / osparc-issues

đŸŒ issue-only repo for the osparc project
3 stars 5 forks source link

Release Notes Improvements #1408

Open SCA-ZMT opened 4 months ago

SCA-ZMT commented 4 months ago

User-friendly release notes instead of flat list of PRs/Issues.

Ideally, these release notes could double as the base for the sprint review.

And idea would be to separate the technical changelog and a monthly/periodical "What's New" which could be a curated blog post or pop-up or ...

### Tasks
- [x] create separate repository for release notes that is public (for now folder in osparc-issues)
- [ ] https://github.com/ITISFoundation/osparc-issues/issues/1563
- [x] sync with app team on where to link the product
- [x] Point products in the deployments to the correct release notes (after release to production on 15th Aug)
- [ ] https://github.com/ITISFoundation/osparc-issues/issues/1637
### Eisbock
- [ ] https://github.com/ITISFoundation/osparc-issues/issues/1722
### MartinKippenberger
SCA-ZMT commented 4 months ago

@eofli Could you please provide a mockup/example?

eofli commented 4 months ago

@SCA-ZMT Please find below an example from the desktop release. Is it what you need?

Sim4Life V7.2.0 Release Notes

Release Date: 13.12.2022

Sim4Life V7.2.0 offers new features and major enhancements that strengthen the world’s leading in silico toolset for computational life science research, device design and optimization, and safety and electromagnetic compliance evaluations.

...

  1. New Features & Enhancements

3.1. Modeling

...

  1. List of Main Bugs Fixed Since V7.0.2 Release

odeimaiz commented 3 months ago

The way Visual Studio does it:

Image

odeimaiz commented 3 months ago

Our issues:

pcrespov commented 3 months ago

IMPORTANT: please do not remove references to the PRs (i.e. the numbers/links) that are already in place, i.e. you can add more info but not remove those links since it is a very useful way to connect witht he changes in the code