OpenLMI documentation suite

Jan Safranek jsafrane at redhat.com
Tue Oct 1 07:57:40 UTC 2013


On 10/01/2013 09:51 AM, Jan Synacek wrote:
> On 10/01/2013 09:34 AM, Jan Safranek wrote:

>> I would appreciate any comments to directory structure, css style or the
>> actual text content. The documentation (in proposed directory structure)
>> will end up on openlmi.org eventually.
> 
> Nice! The CSS looks very well in my opinion. The directory structure looks ok as
> well. I would add 'latest' directory to every subdirectory that would always
> point to the latest version of the docs -- something like a symlink, so you
> could refer to 'latest' in the link, for example. And maybe I would rename the
> current top-level 'latest' to something like 'all' ?

Having 'latest' everywhere is nice idea, I'll try to do some symlinking.

> 
>> It is surprisingly complex process to generate such documentation,
>> partly because different providers use different documentation build
>> process (cmake vs make) and the documentation sources are in different
>> git repositories on different places.
> 
> Let's unite that. For example, since we already use cmake extensively, let's use
> that.

Well, e.g. openlmi-storage does not use cmake at all. Should it?


Jan



More information about the openlmi-devel mailing list