[ 
https://issues.apache.org/jira/browse/ARTEMIS-1714?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16389122#comment-16389122
 ] 

Lionel Cons commented on ARTEMIS-1714:
--------------------------------------

Justin, I know about the list of Jira issues fixed per version. This is why I 
used the term "release information" rather than "list of changes".

I think it would be really useful to have a digest of all the changes and 
present the most important ones in a high-level view. Think of it as an 
executive summary.

Look for instance at the 2.5.0 release notes 
(https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12315920&version=12342127).
 Could they be summarized in less that ten lines?

I've already mentioned ActiveMQ and Kafka, I can add that RabbitMQ does 
something similar, see https://www.rabbitmq.com/changelog.html. Each version 
has a high-level view (in the "Highlights" column) in addition to the link to 
the exhaustive list of all the changes.

> The "release information" is out of date
> ----------------------------------------
>
>                 Key: ARTEMIS-1714
>                 URL: https://issues.apache.org/jira/browse/ARTEMIS-1714
>             Project: ActiveMQ Artemis
>          Issue Type: Bug
>            Reporter: Lionel Cons
>            Assignee: Justin Bertram
>            Priority: Major
>
> It seems that there is only one place in the Artemis sources that contains 
> "release information". It is {{docs/README.md}} and the information there is 
> outdated since it only documents the releases 1.0.0, 1.1.0 and 1.2.0.
> Please keep the "release information" up to date with the new releases.
> It would probably make sense to put this information in the main GitBook 
> guide. A "release" or "changes" page listing all the versions with their 
> major changes (and a link to Jira for the complete list of changes) would be 
> very useful.
> FWIW, ActiveMQ has something similar at 
> http://activemq.apache.org/new-features.html. Kafka documents the "notable 
> changes", see for instance 
> https://kafka.apache.org/documentation/#upgrade_100_notable.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Reply via email to