> > -----Original Message----- > From: Wido den Hollander [mailto:w...@widodh.nl] > Sent: Tuesday, August 21, 2012 7:23 AM > To: cloudstack-dev@incubator.apache.org > Subject: Re: guide in .doc > > On 08/20/2012 11:24 PM, Wido den Hollander wrote: > > > > > > On 08/20/2012 11:05 PM, Jessica Tomechak wrote: > >> I have attached the most recent Installation Guide to the XML > >> conversion signup sheet. This is a Citrix CloudPlatform guide. Since > >> Citrix has made a release more recently than Apache, it contains > >> fixes that should apply to Apache CloudStack 4.0. > >> > >> https://cwiki.apache.org/confluence/display/CLOUDSTACK/Convert+Instal > >> lation+Guide+to+Docbook+XML > >> > >> > >> > >> It's a .docx file, so please let me know if your version of MS Word > >> has difficulty opening it. Older versions can't cope. > >> > > > > I'm going to take care of the Hypervisor installation. > > > > I already did a lot of this in commit > > b6a610e2db5798ae69cfd2cc8a9d7f85617f3926 but I have some stuff locally > > which I'll push this week. > > > > It covers a lot which should also be in the Installation Guide, so > > I'll take care of that. > > > > Where in the repository is this? In /docs is don't see a specific install > guide directory. > > Wido, the documentation is in one directory. The idea behind a flat hierarchy was to make it easy to recombine the modules into various guides. There are many sections that must be included both in the "installation" guide and the "administration" guide, for example.
More benefits: it makes it easier to refer from one module to another for links and such. It reduces the chance that we end up with two versions of the same information. You'd likely (or at least, possibly) notice that there's already a file called "adding-a-pod" or whatever. To find out what's included in a given "book," drill down through the levels of <include> starting from one of the main "book" files. If we need a way to list the files per book, someone could write a script to iterate through those <include>s. We do need a naming convention to make it clear which files are the main book files. Right now, I believe they all look like "cloudstack_<something>.xml" so we could explicitly state that as a naming convention if we like it. Some of this is explained in the README in the /docs directory. It's also discussed in the wiki. https://cwiki.apache.org/confluence/display/CLOUDSTACK/How+To+Work+With+CloudStack+Documentation Jessica T. CloudStack Tech Pubs > I can't find any commits regarding this? Is this still in somebody's local > branch? > > Wido > > > > Wido > > > >> Cheers, > >> Jessica T. > >> CloudStack Tech Pubs > >> > >> On Mon, Aug 20, 2012 at 6:58 AM, sebgoa <run...@gmail.com> wrote: > >> > >>> Hi Jessica, > >>> > >>> Can you share the .doc CP guide with us ? > >>> > >>> It may actually be easier for me to work with the doc file than the > pdf. > >>> > >>> Thanks, > >>> > >>> -Sebastien > >>> > >>> > >>> -Sebastien Goasguen > >>> Cloud Computing Evangelist, Citrix EMEA > >>> > >>> > >>> > >>> > >>> > >> > >
