Changelog Breaking changes Design POC

[BOHEUS]

Right now, Releases are very simple and short but don't contain all information about changes within release, especially breaking changes which becomes more clear with increasing number of questions how to do something or why x isn't working anymore after upgrading. Of course, Releases in repo on Github contain much more information but all of these are links meaning if someone wants to find something, they must check PR and linked issue (if it's linked) to understand the change from a high-level point of view. The idea is to add more details to Releases to make it more user-friendly and transparent with all changes happening between releases; rough idea is to present it in form:

• new features section
• breaking changes section

[BOHEUS]

I'll prepare a POC how it may look in meantime

[Bonapara]

Hi @BOHEUS! We aimed to make the release pages very user-friendly by avoiding information about bugs and API breaking changes. I believe we should include this information in the documentation instead. WDYT?

[BOHEUS]

@Bonapara I think it may do the work as long as it's linked in releases to make sure people will read about them (just to be save than sorry and have additional tickets), where it should be located? In separate page or in upgrade guide? I think separate page makes more sense as it'll allow everyone who's interested in the project to be aware of new changes, not only those who want to upgrade their self-hosted instances

[Bonapara]

Hi @BOHEUS, you're right; we should place them where people will notice. We will start adding them to the changelog. Please go ahead with how it might look if you're still up to it! (without introducing new components). Thanks!