[jira] [Commented] (ARTEMIS-1714) The "release information" is out of date
[
https://issues.apache.org/jira/browse/ARTEMIS-1714?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16390688#comment-16390688
]
Justin Bertram commented on ARTEMIS-1714:
-
Thanks for clarifying. I like the idea of an executive summary, and we also
need a place for version-specific upgrade details. I see a PR -
https://github.com/apache/activemq-artemis/pull/1938. Please review.
> 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
> Fix For: 2.5.0
>
>
> 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)
[jira] [Commented] (ARTEMIS-1714) The "release information" is out of date
[
https://issues.apache.org/jira/browse/ARTEMIS-1714?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=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=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)
[jira] [Commented] (ARTEMIS-1714) The "release information" is out of date
[
https://issues.apache.org/jira/browse/ARTEMIS-1714?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16388335#comment-16388335
]
Justin Bertram commented on ARTEMIS-1714:
-
Each release is accompanied with a link to all the various bugs, features,
improvements, etc. which have been fixed or implemented. See the [current
release|https://activemq.apache.org/artemis/download.html] and [past
releases|https://activemq.apache.org/artemis/past-releases.html] download
pages. In my opinion the files docs/README.md and docs/README.html are
superfluous and should be removed to avoid confusion. If the information
coming from JIRA is confusing this we should do a better job of providing clear
titles, descriptions, etc. to clarify.
> 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
>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)
