Some pages of the Kolab Documentation seem to be broken September 12th, 2016
I noticed that several pages are broken on https://docs.kolab.org
a couple of examples:
- https://docs.kolab.org/architecture-and-design/ldap-intro.html
- https://docs.kolab.org/client-configuration/outlook.html
I once did file a patch to fix the client configuration page (https://git.kolab.org/rDdc928121f87e22602e64669bd640fd63482751d5), but I guess that was not really solving the problem.
I have now setup a Fedora 24 machine, and installed the following packages:
dnf install python-setuptools make graphviz-python graphviz-gd python-pillow python-sphinx python-sphinx-latex git lighttpd which crontabs git clone http://git.kolab.org/diffusion/D/docs.git cd docs make html mv /root/docs/build/html /var/www/htdocs make latexpdf mv build/latex/KolabGroupware.pdf /var/www/htdocs/ systemctl enable lighttpd systemctl start lighttpd systemctl enable crond systemctl start crond |
Every night I run a cronjob to rebuild the documentation.
You can find the result here:
Contributing to Kolab documentation via github/sphinx November 13th, 2013
The new Kolab 3.1 documentation is written in reStructuredText, using a tool called Sqhinx which was originally created for the Python documentation.
It is much easier to edit than the Publican notation used before for the Kolab 3.0 documentation.
The website for Sqhinx is here: http://sphinx-doc.org/
Some useful links for getting started with writing documentation with Sqhinx:
You find the sources of the Kolab Documentation here: https://github.com/kolab-groupware/kolab-docs
You can fork that repository, make your own changes, even online at github.
For more complex jobs, I recommend cloning your github fork locally, and work there, and commit and push when you are happy.
See also a good tutorial at Github for this: https://help.github.com/articles/fork-a-repo
It also makes sense to build the documentation locally, and have a look at your changes.
On CentOS, you need to do this:
yum install python-setuptools make easy_install -U Sphinx wget http://www.graphviz.org/graphviz-rhel.repo -O /etc/yum.repos.d/graphviz-rhel.repo yum install graphviz-python graphviz-gd git clone https://<your github username>@github.com/<your github username>/kolab-docs.git cd kolab-docs make html |
You will find the result in the directory build/html