directory-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Stefan Seelmann <m...@stefan-seelmann.de>
Subject Re: Documentation system
Date Sun, 07 Oct 2012 19:59:29 GMT
On 07.10.2012 20:54, Emmanuel Lécharny wrote:
> Le 10/7/12 8:35 PM, Stefan Seelmann a écrit :
>> Hi,
>>
>> I wanted to ask about the documentation system. Some time ago there was
>> agreement to use version controlled files with wiki synatx that is
>> transformed to docbook and then further transformed to HTML/PDF. Is this
>> still the case or did something change? I ask also wrt to the ongoing
>> migration of the website to the Apache CMS: when using the CMS is it
>> still possible to add static content (i.e. the generated documentation)
>> to the website?
> 
> The Apache CMS uses markdown, not confluence syntax. That means we will
> probaby have to switch to markdown for the documentation, too.
> 
> The good point is that we will be able to have the documentation be
> versionned.
> 
> So I wonder if it would not be a better idea to stop using confluence
> for the existig documentation effort, convert it to markdown (there are
> tools to do that, like http://johnmacfarlane.net/pandoc/)
> 
> wdyt ?

I see.

We already moved all the content to SVN [1][2] but that is a totally
different system. I agree that using the CMS only sounds good.

The only thing is that [1][2] allows different output formats (HTML,
PDF, zipped HTML). I don't think that that is supported by the CMS. But
maybe that is not required.

Kind Regards,
Stefan

[1]
https://svn.apache.org/repos/asf/directory/documentation/apacheds-manuals/trunk
[2]
https://svn.apache.org/repos/asf/directory/documentation/ldap-api-manuals/trunk



Mime
View raw message