Release Notes Improvements

[SCA-ZMT]

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

Beta Give feedback

1. create separate repository for release notes that is public (for now folder in osparc-issues)
2. vendor information keeps track of release notes link for each product #1563
   +0
   
3. sync with app team on where to link the product
4. Point products in the deployments to the correct release notes (after release to production on 15th Aug)
5. Document current release-note-creation approach verbosely #1637
   +0
   
6. Working Group: Decide where release-notes live (sim4life.swiss?) #1722
   +0
   

   

Eisbock

Beta Give feedback

No tasks being tracked yet.

MartinKippenberger

Beta Give feedback

No tasks being tracked yet.

[SCA-ZMT]

@eofli Could you please provide a mockup/example?

[eofli]

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

...

3. New Features & Enhancements

---

3.1. Modeling

• AI-based head segmentation: Automatic segmentation of head MR
  image data into 16 tissue classes with postprocessing features to
  enhance the model quality.
• Electrode placement based on the international 10-10 system:
  Automatic detection of the 10-10 system electrode location and
  automatic placement of electrode models on the reference system.

...

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

---

• Case 135851: Fix the issue preventing Optimizer to run on
  statistics with LF solvers
• Case 167390: Fix the issue related to the detection of surfaces’
  normals when using Topological engine in Thermal solver
• Case 169931: Fix allowing user-defined analysis pipeline to be
  created
• Case 169975: Neuron network now works with HOC files and templates
• Case 172053: Fix the Std-dev equation for All Regions in SAR
  Statistics
  ...

[odeimaiz]

The way Visual Studio does it:

• In the website/blog: They keep the same content well organized per release
• In the App: every time (once a month) the app is updated, it shows the Release notes in the app

[odeimaiz]

Our issues:

• All products are oSPARC based, but some features only apply to specific products
• We might want to somehow merge the platform specific and app specific release notes: oSPARC +TIP, oSPARC +S4L, oSPARC +S4L-lite, oSPARC

[pcrespov]

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