[Openstack-docs] [ha-guide] Conversion to docbook

Anne Gentle anne at openstack.org
Thu May 2 20:07:48 UTC 2013


I'm fine with keeping ASCIIdoc for this guide.

We take docs in any format and "eventually" convert them to docbook, even
if it's under the covers. So if you sense that docbook is the standard,
it's because we need it for the eventual consistent output. Markdown or RST
to Docbook is not great but ASCIIdoc to docbook is great.

Anne


On Wed, May 1, 2013 at 3:49 PM, Emilien Macchi
<emilien.macchi at enovance.com>wrote:

> I totally agree that ASCII is easier for everybody.
> The fact is OpenStack HA Guide is the only one which does not follow
> recommendations written here :
>
>
> https://wiki.openstack.org/wiki/Documentation/HowTo#docs.openstack.org_.28DocBook_5.29
>
>
> Now, here my point of view :
>
> - Why I like ASCII : because as you say, it's easier to write with this
> language.
> - Why I send this email : just because I don't like to be alone in
> writing with ASCII while others use DocBook.
>
> If nobody contradict us, I would suggest keeping ASCII for this guide.
>
>
> Cheers,
>
> Emilien Macchi
> ----------------------------------------------------
> # OpenStack Engineer
> // eNovance Inc.              http://enovance.com
> // ✉ emilien at enovance.com     ☎ +33 (0)1 49 70 99 80
> // 10 rue de la Victoire 75009 Paris
>
> On 05/01/2013 07:45 PM, Florian Haas wrote:
> > On 05/01/2013 06:47 PM, Emilien Macchi wrote:
> >> Hi,
> >>
> >>
> >> Is anyone against the idea to convert openstack-ha guide from asciidoc
> >> to docbook (which is the official language) ?
> >>
> >>
> >> Cheers
> >>
> > I would object, because we have few enough doc writers as it is, and
> > switching to DocBook is going to raise the barrier to entry for new
> > contributors, not lower it.
> >
> > However, don't let that stop you from trying to convince me. :) What are
> > your points in favor of DocBook?
> >
> > Mind you, I wrote straight-up DocBook for years, and then converted to
> > AsciiDoc because I found positively nothing that was both useful in
> > DocBook, and un-expressible in AsciiDoc.
> >
> > What do others think?
> >
> > Cheers,
> > Florian
> >
>
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20130502/6e4e4026/attachment.html>


More information about the Openstack-docs mailing list