On 13.09.2018 13:01, Stefan Sperling wrote: > On Thu, Sep 13, 2018 at 11:50:57AM +0100, Julian Foad wrote: >> Stefan Sperling wrote: >>> I don't think many people follow these references when reading CHANGES. >> [...] >>> I believe a short note at the top of the file which explains how to >>> resolve these references would be sufficient. Something like this maybe: >>> >>> To view a revision listed in change log entries below, visit: >>> https://svn.apache.org/rXXXX [...] >> That's a good start (let's do it), but it feels unprofessional and backward >> to me to not provide linked information in a software project in this >> century. It is one of many little things that together add up to a poor >> usability, and I would like to improve the usability of the project as a >> whole, and this is one way to do so. > How about we provide a linkified version of CHANGES in our > release notes HTML pages? We could add a 'Detailed Changelog' section, > in addition to linking to the CHANGES file as these pages already do. > > The contents of this new section would be based on only the respective > release's section of the CHANGES file as shipped in release tarballs, > with links added. For instance, the page > http://subversion.apache.org/docs/release-notes/1.10.html would be > updated with 1.10.x CHANGES entries each time a 1.10.x release is made. > > It should not be too hard to automate the process. The release.py > script already has some commands which spit out HTML snippets for > the news pages so it might as well be parsing CHANGES and produce > HTML we can paste into the website.
+1. I have a bit of time tonight to have a go at the scripting. -- Brane