+1 asciidoc. really, any of the asciidoc, docbook, markdown will get you a much easier learning curve for new contributors than alternatives.
On Wed, Dec 17, 2014 at 1:58 PM, Tony Kurc <[email protected]> wrote: > Or LaTex [1]. Same advantages. > > [1] http://www.latex-project.org/ > > On Wed, Dec 17, 2014 at 2:38 PM, Adam Taft <[email protected]> wrote: > > > > Would highly recommend writing the user guide in asciidoc. It can then > be > > easily contributed/merged, etc. using normal text editing + git tools. > > > > Pro Git, 2nd Ed. is written in Asciidoc, as an example. > > > > > > > https://medium.com/@chacon/living-the-future-of-technical-writing-2f368bd0a272 > > > > Here is the git repository associated with the book: > > > > https://github.com/progit/progit2 > > > > > > > > > > > > > > On Wed, Dec 17, 2014 at 2:24 PM, Mark Payne <[email protected]> > wrote: > > > > > > All, > > > I have started work on a NiFi User Guide ( > > > https://issues.apache.org/jira/browse/NIFI-150). There is a lot of > work > > > to be done here for sure, and I've only really started. However, what > > I've > > > written up so far may be useful to those of you who haven't had a > chance > > to > > > learn NiFi yet. General terminology is described, some of the icons are > > > explained, etc. > > > So far I've been writing it Open Office. I don't know if this is the > > > format that we want to stick with, but that can easily be changed > later. > > It > > > is checked into the NIFI-USER-GUIDE branch, under > > > > > > nar-bundles/framework-bundle/framework/resources/src/main/resources/docs. I > > > expect to be adding quite a bit to this in the coming days. > > > Thanks-Mark > > > > > > > > > > > > -- Sean
