[Openstack-docs] Common Folder

Andreas Jaeger aj at suse.com
Wed Jul 23 08:17:21 UTC 2014


On 07/23/2014 09:46 AM, Pranav Salunke wrote:
> Anne,
> 
> I think useage of xml:id tag will not work across repositories, hence
> the issues I was facing. To be very clear, training-manuals builds were
> failing straight away. It was a bit hectic to get it back on track.
> 
> We need to use xi:include for including common folder's content and
> xpointer for the xml:id. So you see the problems faced. This patch will
> give you some idea of what exactly happened.
> https://review.openstack.org/#/c/108263/3/doc/training-guides/associate-guide/bk001-ch007-associate-network-node.xml

Looking at that change: The file was just moved from one location to
another, just changing the path would have been enough...

Still, I don't understand why you include this in the training guides, a
reference to the CLI guide would be enough,

Andreas

> Ignore the xi:fallback part, I could not fix the changes myselves
> because someone else had taken up the bug. But it was eventually fixed.
> http://git.openstack.org/cgit/openstack/training-guides/commit/?id=67f88dd957e78f850bfb4e04281f56ff2a432188
> 
> 
> On Mon, Jul 21, 2014 at 6:50 PM, Anne Gentle <anne at openstack.org
> <mailto:anne at openstack.org>> wrote:
> 
>     Hi Pranav,
>     I don't know if the file names are changing, do you have evidence of
>     a file name change so I can troubleshoot further? 
> 
>     My working theory is that the conditionals are causing the error you
>     pasted. The file is "not found" because it has a particular
>     condition. As an example, any image starting with dbconfig- 
>     is not accessible to the build unless the condition os="debian" is met.
> 
>     We typically use xml:id so that file name changes do not matter, but
>     it does require everyone to refer to items only by xml:id. In the
>     case of images, the reference to the image would need an xml:id on
>     it, that the training guide would then reference. 
> 
>     This difficulty happens often when sharing content, I've seen it
>     many times. We can work through it with the toolchain we have, I
>     believe.
>     Anne
> 
> 
>     On Sun, Jul 20, 2014 at 9:42 PM, Pranav Salunke
>     <dguitarbite at gmail.com <mailto:dguitarbite at gmail.com>> wrote:
> 
>         Hello,
> 
>         I have seen a few changes in the common folder present under
>         openstack-manuals repository break training manuals.
>         Particularly the changes which include file name change. We need
>         to address this so that the training manuals and other
>         repositories which use common folder can adopt to the changes.
>         These changes should be merged only when the dependences under
>         other documentation related projects are addressed.
> 
> 
>         The other issue with common folder arises with relative paths
>         which gives following errors.
>         http://paste.openstack.org/show/86763/
>         We need to address these errors properly to encourage re-use of
>         existing material. Can we discuss these issues during the IRC
>         meeting or during the design session at Juno Summit?
>         Regards,
>         Pranav
> 
>         _______________________________________________
>         Openstack-docs mailing list
>         Openstack-docs at lists.openstack.org
>         <mailto:Openstack-docs at lists.openstack.org>
>         http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
> 
> 
> 
> 
> 
> _______________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
> 


-- 
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter: jaegerandi
  SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
   GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126



More information about the Openstack-docs mailing list