accumulo-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Josh Elser (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (ACCUMULO-2394) Create release notes
Date Sun, 23 Feb 2014 02:27:19 GMT

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

Josh Elser commented on ACCUMULO-2394:
--------------------------------------

I had some down time today, so I started poking around. Made a basic release notes Jekyll
site. I like it because all it requires is making a new markdown/html file named mm-dd-yyyy-version.md
(e.g. 2013-05-27-1.5.0.md), and it will automatically update a new website with the content.

The index page shows the most recent releases first, and allows you to directly link to a
specific version. I made enough style changes to make it not completely ugly, and the content
is all lorem ipsums, but it should convey the idea.

I like the idea of keeping this in the main source tree (use/write a quick maven-jekyll-plugin
or just exec out to the command line), but that would introduce more effort to get it into
the ASF CMS. Not entirely sure, but I wanted to at least start it out.

Code: https://github.com/joshelser/accumulo-release-notes
Staged: http://accumulo-release-notes.penguinsinabox.com/

> Create release notes
> --------------------
>
>                 Key: ACCUMULO-2394
>                 URL: https://issues.apache.org/jira/browse/ACCUMULO-2394
>             Project: Accumulo
>          Issue Type: Task
>          Components: docs
>            Reporter: Josh Elser
>
> The big point that came out of the massive discussion on the CHANGES file is that we
should also be generating an easy-to-consume release notes page.
> Ideally, we want something visually appealing, easy for us to maintain, version controlled
and not requiring manual HTML (e.g. Markdown, etc).



--
This message was sent by Atlassian JIRA
(v6.1.5#6160)

Mime
View raw message