cloudstack-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Ewan Mellor <Ewan.Mel...@eu.citrix.com>
Subject RE: DOCS: problems with using entities
Date Wed, 08 Aug 2012 01:02:28 GMT
> -----Original Message-----
> From: Ewan Mellor
> Sent: Tuesday, August 07, 2012 5:47 PM
> To: cloudstack-dev@incubator.apache.org
> Subject: RE: DOCS: problems with using entities
> 
> > -----Original Message-----
> > From: David Nalley [mailto:david@gnsa.us]
> > Sent: Tuesday, August 07, 2012 3:37 PM
> > To: cloudstack-dev@incubator.apache.org
> > Subject: DOCS: problems with using entities
> >
> > Hi folks.
> >
> > I experienced a problem today building the docs set now that we have
> > an entity in place. The problem that I found was: (building with
> > --format=test succeeds, but specifying a real output fails
> complaining
> > about not being able to locate an entity.)
> >
> > Joe has begun working around this by specifying the entity file in
> the
> > XML declaration.
> >
> > The problem is, that when compiling to a real output format it
> expects
> > to find Doc_name.ent - and of course that isn't there. cloudstack.ent
> > is the only thing present. If there are no declared entities, you
> > never see a problem. However, publican.cfg declares the name to be:
> > release-notes-3.0.4, however there are a number of these, so my
> > supposition is that it's all designed to work with a single set of
> XML
> > documents and picking which are included for any given document
> > produced.
> >
> > So how do we solve this. symlink a .ent to cloudstack.ent file for
> > each doc produced? Create a directory to house all of the XML files
> > and symlink them as appropriate to the document they are to be
> > included in? Something else?
> 
> Having release-notes-3.0.4 in the publican.cfg obviously doesn't make
> any sense.  I presume we need multiple publican.cfg files, one for each
> doc that we want to build.
> 
> Looking at the Publican docs, symlinking a Doc_name.ent to
> cloudstack.ent (or something like that) seems like the only sensible
> option open to us.  The Publican docs have a long rant about how what
> we are doing is evil, but I don't see any alternative.
> 
> Ewan.
> 
> http://docs.fedoraproject.org/en-
> US/Fedora_Contributor_Documentation/1/html/Users_Guide/chap-
> Users_Guide-Creating_a_document.html#sect-Users_Guide-
> Files_in_the_book_directory-Doc_Name.ent

By the way, I created a Jenkins job that runs Publican.  So now we know automatically and
reliably that it doesn't work right now.

http://jenkins.cloudstack.org/job/build-docs-master/

Ewan.


Mime
View raw message