Re: [DISCUSS] Documentation

2016-11-13 Thread Gunnar Tapper
Hi Jonathon, Thanks for the great information! I'll definitely look into supporting ePub and Mobi formats as well as thinking through if the process can be improved. As for multi-book, I fell in love with it back when using FrameMaker. A word processor supporting emacs commands can never be wrong

Re: [DISCUSS] Documentation

2016-11-13 Thread Bertrand Delacretaz
On Sat, Nov 12, 2016 at 8:45 PM, toki wrote: > ...Five options, each of which creates a slightly different PDF... That's (obviously ;-) only relevant if your project wants to produce PDF documentation. A large part of Apache projects are perfectly happy with Web-based documentation which has muc

Re: [DISCUSS] Documentation

2016-11-12 Thread toki
On 12/11/2016 04:09, Gunnar Tapper wrote: > For documentation, I couldn't find an easy way to do multi-chapter books, If AOo is meant, use Master Documents. There are a couple of use cases (^1 ), where Master Documents don't work. In those instances, virtually every solution will fail. (^2) > b

Re: [DISCUSS] Documentation

2016-11-12 Thread toki
On 11/11/2016 07:46, Gunnar Tapper wrote: > there's a clear preference to use Apache OpenOffice for documentation. The driving force behind that was Sun's insistence that their own dog food be eaten. > Beyond usability (and therefore more willingness to document), it also makes > translation ea

Re: [DISCUSS] Documentation

2016-11-11 Thread Gunnar Tapper
Hi Stain, I used different wiki technologies for documentation in a previous project. One of the large blockers was that it was very hard to deal with versioned documentation, especially when dealing with many different manuals. To me, wikis work well for documentation targetted to developers that

Re: [DISCUSS] Documentation

2016-11-11 Thread Stian Soiland-Reyes
I guess primarily the answer is that your project should discuss this and use whatever they are comfortable with; the incubator is not forcing any technology. I would say that you should avoid proprietary formats (e.g. .docx) so that anyone can contribute. I think for developers Markdown (which is

Re: [DISCUSS] Documentation

2016-11-11 Thread Gunnar Tapper
Thanks Shane. I started my career with (MUCH OLDER) markup languages in text editors where you had special tags for change bars etc. I agree that source control help diffs for developer while word processors provide easy ways to show diffs to the user. Wearing my UX hat, I optimize for users and

Re: [DISCUSS] Documentation

2016-11-11 Thread Gunnar Tapper
For people in this particular incubator. ;) On Nov 11, 2016 2:37 AM, "Bertrand Delacretaz" wrote: > On Fri, Nov 11, 2016 at 8:46 AM, Gunnar Tapper > wrote: > > ...Talking with other contributors, there's a clear preference to use > Apache > > OpenOffice for documentation > > *for some peopl

Re: [DISCUSS] Documentation

2016-11-11 Thread Shane Curcuru
Bertrand Delacretaz wrote on 11/11/16 9:37 AM: > On Fri, Nov 11, 2016 at 8:46 AM, Gunnar Tapper > wrote: >> ...Talking with other contributors, there's a clear preference to use Apache >> OpenOffice for documentation > > *for some people*, right? I think many of us are big fans of creating >

Re: [DISCUSS] Documentation

2016-11-11 Thread Bertrand Delacretaz
On Fri, Nov 11, 2016 at 8:46 AM, Gunnar Tapper wrote: > ...Talking with other contributors, there's a clear preference to use Apache > OpenOffice for documentation *for some people*, right? I think many of us are big fans of creating documentation using structured text in version control repo

[DISCUSS] Documentation

2016-11-10 Thread Gunnar Tapper
Hi, Related to the muti-lingual issue but also separate since it has to do with tools. This might be the wrong list to so please feel free to redirect. I've created a lot of documentation for Trafodion using Asciidoc, which allows the project to include the documentation with the source. It's OK