> On 3. Oct 2017, at 16:35, Bertrand Delacretaz <[email protected]> wrote: > > Hi, > > On Tue, Oct 3, 2017 at 3:50 PM, Konrad Windszus <[email protected]> wrote: >> ...I think we also once discussed on the mailing list where to put bundle >> documentation: either in the readme or in the site itself... > > Now that we have complete control over the website we might generate > http://sling.apache.org/documentation/bundles.html (or part of it) > using the GitHub API, or the module list that we use for Jenkins, and > mostly use the module's README.md from now on.
That sounds really good. @Robert: Would it be possible to maintain the module list as separate JSON file (currently contained in https://svn.apache.org/repos/asf/sling/trunk/tooling/jenkins/create_jobs.groovy). Then we could easily use it for this purpose as well. The only question would be, when and how to trigger the update. Also we would have two different possibilities here: 1. Just link towards the readme.md (we must link to Github though, as Apache's Gitbox doesn't seem to be able to render the HTML from the MD, compare with https://gitbox.apache.org/repos/asf?p=nutch.git;a=blob;f=README.md;h=3aed205beb13d5b76c257d192d6c23d94669be35;hb=HEAD) 2. Generate the HTML page within the Sling site for each found readme. I would rather be in favour of option 2 though, as otherwise the readme link would only point towards Github, but of course then the updating issue is even more interesting... Konrad > > Patches welcome ;-) > > -Bertrand
