I agree the source control 'friendliness' is an important consideration. Once we have multiple active authors contributing documentation it becomes really important. The current lack of documentation though is critical.
We can go from any format to any format but we can't convert nothing to something. So in that spirit am grateful to whomever gets the documentation party started however they are willing to. Thanks Joe On Wed, Dec 17, 2014 at 4:30 PM, Mark Payne <[email protected]> wrote: > > I definitely see the benefit of having the Git-tracking friendliness. > Though I'm not convinced that the benefit outweighs the cost. At this point > I'd much prefer a format that provides a fully featured word processing > capability over any markup format for a document this extensive... > > Sent from my iPhone > > > On Dec 17, 2014, at 4:10 PM, Karl Heinz Marbaise <[email protected]> > wrote: > > > > Hi Tony, > > > > to be honest I'm using LaTeX for a very long time (ca. 20 years) which > is great but i have started to use asciidoc for a longer time (about a > year) and it's much simpler to learn to understand and to use it with VCS > etc. > > > > Furthermore I have started to use markdown for my blog for about two > years which makes it simpler using the things in Git etc. > > > > From asciidoc you can create every kind out of the format from it like > LaTeX from it...HTML / XML etc. > > > > I have to say LaTeX has some advantages which do not really count > here...the KISS principle is here the key..there a big differences between > asciidoc/markdown and LaTeX ... > > > > > > so i would definitely vote for asciidoc or markdown... > > > > > > for Markdow an doxia converter exists...but this should prevent from > using asciidoc...might be chance to push support asciidoc in Maven..but > this is a different story... > > > > > > Kind regards > > Karl Heinz Marbaise > > > >> On 12/17/14 8:58 PM, Tony Kurc 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 > >>>> > >>>> >
