[jgroups-users] Converted the docs from Docbook --> AsciiDoc
Brought to you by:
belaban
From: Bela B. <be...@ya...> - 2014-08-19 09:56:28
|
FYI: I converted the tutorial [1] and manual [2] from DocBook to AsciiDoc. It is much nicer and therefore more enticing to write documentation in AsciiDoc than in DocBook, and the generated HTML looks really nice as well. I used AsciiDoctor to do this. I also dropped the PDF generation, which IMO is not needed as everyone's online all the time anyway nowadays. Note that GitHub supports AsciiDoc natively, so [3] renders directly in the browser. 'GitHub Pages' (github.io) doesn't yet support AsciiDoc, but once they do, I might move the docs to github.io ... this might ultimately lead to more contributions (e.g. typo fixes, changing incorrect docs etc) as changes can be made directly on the web page (with appropriate permission), similar to a wiki, and then a git pull would update the local docu. Very nice, although I have to figure out how to handle the part of the docs that we generate from the code (e.g. the protocol list). [1] http://www.jgroups.org/tutorial/index.html [2] http://www.jgroups.org/manual/index.html [3] https://github.com/belaban/JGroups/blob/master/doc/manual/api.adoc -- Bela Ban, JGroups lead (http://www.jgroups.org) |