cloudstack-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Sebastien Goasguen <run...@gmail.com>
Subject Re: [DOCS] LXC documentation
Date Tue, 02 Apr 2013 08:37:47 GMT

On Apr 1, 2013, at 3:54 PM, Phong Nguyen <pnguyen@gilt.com> wrote:

> Hi,
> 
> I have been working on adding LXC documentation [1].
> 
> LXC is very similar to KVM in terms of setup, so I would like to reuse most
> of the KVM sections to avoid duplicate documentation. With the unique IDs
> in the KVM sections, Publican will error out during build because it will
> find duplicate IDs since these sections are included more than once.
> 
> As a workaround, I was able to define the <section> tags with unique IDs
> for LXC and used xpointer references to source all children of the
> <section> tag in the included KVM xml files. This works as expected,
> however, it's brittle and I'd like to find a better solution.
> 
> What approach should we take for reusable documentation (within the same
> book)? Should we not use any IDs in xml fragments that are deemed reusable?
> 

Can't you just make a reference to the section without including it entirely.
Something like "For this configuration see section XXX in the KVM chapter" ?

> [1] https://reviews.apache.org/r/10224/
> 
> Thanks,
> Phong


Mime
View raw message