Hi Gert,

Achim already pushed on Karaf the "migration" to AsciiDoc.

Regards
JB

On 01/27/2015 10:22 AM, Gert Vanthienen wrote:
L.S.,


Between Wim's original Sphinx proposal and AsciiDoc, it seems like the
latter has more votes for it. So, next step: anyone up for taking a
stab at transforming the current Scalate docs into AsciiDoc? Perhaps
in a set of branches next to our current docs branches?


Regards,

Gert Vanthienen


On Sat, Jan 24, 2015 at 12:49 AM, Wim Verreydt <[email protected]> wrote:
Hi,

A while ago I figured that the ServiceMix documentation could use an upgrade. 
Instead of fixing everything I took the chance to experiment with some suitable 
frameworks like Middleman, Jekyll and Sphinx.

The first two did not really made thing easier but Sphinx 
(http://sphinx-doc.org/) seems like a big improvement. It is beïng used in a 
lot of non-python projects these days so it should lower the learning curve an 
effort to contribute documentation.

I started out with the well known theme provided by readthedocs.org 
(https://github.com/snide/sphinx_rtd_theme) and added some custom functionality 
like an terminal window in CSS that should replace the screenshots in our 
current documentation.

Just to test I ported the first two guides of the ServiceMix documentation.
You can find the project at https://github.com/wimve/smx-doc-sphinx and a html 
build at https://dl.dropboxusercontent.com/u/1528761/smx-doc-sphinx/index.html

Let me know what you think! If this is considered to be an improvement I'll 
continue to port the rest of our guides.

Regards,

Wim Verreydt

--
Jean-Baptiste Onofré
[email protected]
http://blog.nanthrax.net
Talend - http://www.talend.com

Reply via email to