You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@kafka.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2016/07/27 05:36:20 UTC
[jira] [Commented] (KAFKA-3851) Add references to important
installation/upgrade notes to release notes
[ https://issues.apache.org/jira/browse/KAFKA-3851?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15395078#comment-15395078 ]
ASF GitHub Bot commented on KAFKA-3851:
---------------------------------------
GitHub user ewencp opened a pull request:
https://github.com/apache/kafka/pull/1670
KAFKA-3851: Automate release notes and include links to upgrade notes for release and most recent docs to forward users of older releases to newest docs.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/ewencp/kafka kafka-3851-automate-release-notes
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/kafka/pull/1670.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #1670
----
commit b2ecaa27aca21f715bd4dc88ce8f898a7ccfcaab
Author: Ewen Cheslack-Postava <me...@ewencp.org>
Date: 2016-07-27T05:33:29Z
KAFKA-3851: Automate release notes and include links to upgrade notes for release and most recent docs to forward users of older releases to newest docs.
----
> Add references to important installation/upgrade notes to release notes
> ------------------------------------------------------------------------
>
> Key: KAFKA-3851
> URL: https://issues.apache.org/jira/browse/KAFKA-3851
> Project: Kafka
> Issue Type: Bug
> Affects Versions: 0.10.0.0
> Reporter: Ewen Cheslack-Postava
> Assignee: Ewen Cheslack-Postava
> Priority: Blocker
> Fix For: 0.10.0.1
>
>
> Today we use the release notes exactly as exported from JIRA (see "Prepare release notes" on https://cwiki.apache.org/confluence/display/KAFKA/Release+Process) and then rely on users to dig through our documentation (none of which starts with release-specific notes) to upgrade and installation notes.
> Especially for folks who aren't intimately familiar with our docs, the information is *very* easy to miss. Ideally we could automate the release notes process a bit and then have them automatically modified to *at least* include links at the very top (it'd be nice if we had some other header material added as well since the automatically generated release notes are very barebones...). Even better would be if we could pull in the version-specific installation/upgrade notes directly.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)