[HADOOP-2804] Formatable changes log as html

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 0.17.0
• Component/s: documentation
• Assignee: Nigel Daley
• Reporter: Nigel Daley
• Created: 09/Feb/08 02:15
• Updated: 21/May/08 20:05
• Resolved: 14/Mar/08 23:33

Description

We could do a better job of generating useful release notes. As a first step, I suggest we follow Lucene's lead and add html formatting to our CHANGES.txt. An example output is here:

http://hudson.zones.apache.org/hudson/view/Lucene/job/Lucene-trunk/lastSuccessfulBuild/artifact/trunk/build/docs/changes/Changes.html

This should then be included with our release documentation that is published on the website for each release.

After this is committed, the next step is for committers to agree on a CHANGES.txt convention that will flag major features/improvements (such as a well placed *). Then the flagged Jira's can be further highlighted when generating the html.

Thoughts?