[OpenStack-docs] Handling common sections

Andreas Jaeger aj at suse.com
Wed Oct 15 13:01:50 UTC 2014


On 10/15/2014 01:34 PM, Lucian Petrut wrote:
> Hi guys,
> 
> We’re working on updating the documentation for Windows related drivers
> such as Nova Compute Hyper-V Driver and Cinder Volume Windows Driver.
> The issue is that there are a few common sections, such as the one
> related to configuring NTP or common requirements.
> 
> I was thinking about putting those in separate XMLs and linking them.
> I’m not sure where should those be placed though.
> 
> I would really appreciate some ideas!

One option would be to document these at the first occurrence and use in
later places a link to the first one like:
First, configure NTP as explained in <xref linked="windows-ntp"/>.

Andreas
-- 
 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