On 12/13/2013 02:02 AM, Bruno Mahé wrote: I did not forget about this. I will push whatever I have this week end for review.
Re: Documentation overhaul
Konstantin Boudnik 2014-04-08, 21:08
I wanted to revitalize this thread as Bruno's proposed overhaul makes a lot of sense. And it seems that everyone is agreed on this. I had a number of the offline discussions with Sean, Jay, Roman and other guys (not singling out these guys, but otherwise the list would be too long;)
I think we all are in agree that the high level scope does totally make sense and all these guides are very important fr the success of the project.
What I want to discuss is the tools that we can use for it. As I see, a requirement to be able to generate a PDF book to hand it out to a user is very important.
I want to put upt to the discussion a list of choices that we have to do the job. Once we are in consensus on the toolset/format we can move forward real fast. The way I see it is that the following formats can be used: - docbookx (what HBase uses, XML base format) - markdown (a text based format without much overhead formatting) - asciidoc (similar to markdown, but somewhat different, I don't know much about it) - an online CMS system of some kind
I would like to see what you guys think about all this and what would be a preferred way of generating/controlling/managing the versions of the documentation.
Please chime in!
On Sun, Dec 08, 2013 at 09:35PM, Bruno MahИ wrote:
All projects made searchable here are trademarks of the Apache Software Foundation.
Service operated by Sematext