[Openstack] On documentation management

Arnaud Quette aquette.dev at gmail.com
Tue Dec 6 23:11:19 UTC 2011


Hi Anne,

2011/12/6 Anne Gentle <anne at openstack.org>

> Hi Arnaud -
> Asciidoc is great and we can work it into our toolchain. O'Reilly
> offers authors the option of either authoring in DocBook (which is
> most of our source on docs.openstack.org) or Asciidoc.
>

great thing!


> I like to accept documentation in any format - even Word docs printed
> and handed to me from a briefcase at the Design Summit. We had many
> pages of documentation already in DocBook when I joined. I'm
> interested in building a community of contributors and finding ways to
> enable their contributions, so all formats are welcomed.
>

good to know, for future contributions.

Feel free to contact me with specific ideas about Asciidoc contributions.
>

As per your above comment, I'm still not sure if it means you're
considering a switch from Sphinx+RST (seen in Nova sources) and Docbook to
Asciidoc. Any clarification would be appreciated.

As far as I've seen, you already have a good level of build automation with
Sphinx + RST.
But things could probably be improved, in terms of build rules
simplification, removal of redundant content (if any), and general
simplification.

cheers,
Arnaud
-- 
Linux / Unix Expert R&D - Eaton - http://powerquality.eaton.com
Network UPS Tools (NUT) Project Leader - http://www.networkupstools.org/
Debian Developer - http://www.debian.org
Free Software Developer - http://arnaud.quette.free.fr/
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack/attachments/20111207/3b62081e/attachment.html>


More information about the Openstack mailing list