[OpenStack-docs] For new documentation, shall we use Docbook or RST?

Andreas Jaeger aj at suse.com
Thu Mar 12 09:30:25 UTC 2015


On 03/12/2015 07:32 AM, Bernd Bausch wrote:
> And if I write new documentation in RST, is there a repository where I
> should put it?

Do you mean: A new manual? For those, please write a spec first - a
patch for docs-specs repository.

And for new manuals, preference is RST.

A single manual should have either DocBook or RST - not both.

> 
> Finally, I wonder where in the source tree a new documentation file
> should go. Can I decide that and create the links to and from other files?

A file that is added to one guide should go into the guide directory, so
a file for Install Guide goes in openstack-manuals/doc/install-guide

If a file is used by more than one guide, we move it to doc/common,

Andreas
-- 
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
  SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
   GF: Felix Imendörffer, Jane Smithard, Jennifer Guild, Dilip Upmanyu,
       Graham Norton, HRB 21284 (AG Nürnberg)
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126




More information about the OpenStack-docs mailing list