[OpenStack-docs] Writing RST Conventions

Andreas Jaeger aj at suse.com
Tue Nov 11 14:34:44 UTC 2014


On 11/11/2014 03:21 PM, Anne Gentle wrote:
> 
> 
> On Sat, Nov 8, 2014 at 12:51 PM, Andreas Jaeger <aj at suse.com
> <mailto:aj at suse.com>> wrote:
> 
>     As discussed on Friday at the Docpod, I'd like to add RST conventions so
>     that they can be used by others, for example infra-manual.
> 
>     Looking at
>     https://wiki.openstack.org/wiki/Documentation/Docbook_conventions I
>     propose to rename the page from "Docbook conventions" to "Markup
>     conventions" and add for each Docbook example a corresponding RST
>     example.
>     I prefer this option (having Docbook and RST on the same page) since
>     that also helps with moving from one to the other.
> 
>     Alternative would be a complete new page.
> 
>     Anybody with objections with moving forward with a single page?
> 
> 
> Ah, good thinking. So on that page, can we provide a mapping of Docbook
> to RST? Such as:
> docbook=rst
> command = :command:
> filename = :file:
> literal = :samp:
> programlisting = ?
> screen = ?


I would document both together, so each example would explain both RST
and Docbook

Not a quick reference yet - but we can add this at the end if needed as
well (if none exists so far),

Andreas
-- 
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
  SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
   GF:Jeff Hawn,Jennifer Guild,Felix Imendörffer,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