Hi all,
this was a productive week-end and the new documentation is nearly
ready. To celebrate this, I've already decided to make it official,
despite there is stille some work to do.
The links provided in my previous mail are still working and will become
the official ones, and everything is also available from the index page :
http://cbonte.github.io/haproxy-dconv/
Important change :
I've decided to remove the search box. It was a funny toy but some
people reported that they expected it was a full text search box, which
was not true, and the library behind it looks to not be maintained
anymore. To replace the feature, I've added tabs at the left : one to
navigate in the chapters, another to list all the keywords.
This will allow to use only search tool : the one provided by the
browser ;-)
Now, I'll try to work on less critical tasks :
- remove the old documentation files and redirect to the new ones.
- fix the parsing issues I still have at some places (mainly false
positives on keyword detection).
- add a filter box in the keywords tab.
Cheers,
Le 27/06/2016 à 23:40, Cyril Bonté a écrit :
Hi all,
It's been monthes since haproxy has introduced new documentation files
in 1.6 and 1.7-dev (ie. intro.txt, management.txt, ...). Until now, I
hardly found time to include them in the HTML documentation. It's time
to seriously work on this issue !
There is quite a lot of things to do before I can say everything is
ready, but let's go ! This means that things will break for some days.
At least, currently I've disabled the job that regenerates the
documentations automatically until things become more stable again (New
documentation commits won't appear).
I'm also thinking of reorganizing the documentation with one directory
per major version (1.4, 1.5, 1.6, 1.7).
Tasks in the highest priorities :
- allow to navigate between files
- search keywords in all files
- fix rendering issues (I know there are several parts that are not
correctly parsed)
As an early preview those files are available here :
- haproxy 1.4
http://cbonte.github.io/haproxy-dconv/1.4/configuration.html
- haproxy 1.5
http://cbonte.github.io/haproxy-dconv/1.5/configuration.html
- haproxy 1.6
http://cbonte.github.io/haproxy-dconv/1.6/intro.html
http://cbonte.github.io/haproxy-dconv/1.6/configuration.html
http://cbonte.github.io/haproxy-dconv/1.6/management.html
- haproxy 1.7
http://cbonte.github.io/haproxy-dconv/1.7/intro.html
http://cbonte.github.io/haproxy-dconv/1.7/configuration.html
http://cbonte.github.io/haproxy-dconv/1.7/management.html
--
Cyril Bonté
