On Mon, Aug 31, 2015 at 10:41:17AM +0200, Pavlos Parissis wrote: > > On 29/08/2015 08:22 ????, Cyril Bonté wrote: > > Hi all, > > > > Le 27/08/2015 16:33, Willy Tarreau a écrit : > >> Well, the result is pretty good. Here I'm having the search box partially > >> overlap with the text, probably due to a missing logo, but navigation > >> links > >> work fine and chapters as well. I've just fixed the too long line, thanks > >> for this. > > > > I've worked on generating the new intro.txt file. > > Currently, it's only available for the 1.6 snapshot : > > http://cbonte.github.io/haproxy-dconv/snapshot/intro-1.6.html > > > > As soon as a version tag will be set, it will also be available as a > > stable link here : > > http://cbonte.github.io/haproxy-dconv/intro-1.6.html > > > > Looks perfect, thanks for picking up my request so fast! > > > I think I'll do some more work next weeks to see how I can dynamically > > render a navigation menu for all the documents and versions (stable and > > snapshot). I'll also see if it's possible to include the other > > documents, at least : > > - architecture.txt > > - coding-style.txt > > - proxy-protocol.txt > > > > Maybe reStructuredText as a format and Sphinx tool could help here, but > it will require quite a bit of work to migrate to.
It was evocated, I'm not opposed to it, I just want to ensure first that people don't have to *learn* the doc language to contribute doc. Ie: if the format is broken in a patch, it should not result in utter crap on the output nor in errors during conversion. That's why we have the current format in the first place : instead of having people learn a language, we have Cyril's tool which learns people's language. In the end it makes the doc contributions extremely smooth. Cheers, Willy
