[Openstack-docs] Operations Manual.

Jonathan Proulx jon at jonproulx.com
Sun Aug 5 18:49:00 UTC 2012


I'd really like to have an operations manual to read but since it's
not written yet and I need to start writing internal operations
documentation I'd be happy to help write it as I go...

In https://review.openstack.org/#/c/10487

Tom translated the etherpad outline at
http://etherpad.openstack.org/EssexOperationsGuide into docbook.  Anne
expressed concern about setting the mark up format and scaring off
potential contributors.  Lorin expressed some support for trying out a
lighter markup to see if that attracted more authors and someone of
that set of people suggested moving the discussion to this mailing
list.

I've not see any discussion here so let's discuss :)

I don't have any background in document markup, only even looked at
docbook maybe two weeks ago when I was trying to figure out my first
documentation bug fix, so I don't have any particular opinions other
than thinking we should set something so that it's possible for
authors to start contributing.  There's a lot of value in using the
lightest markup that will do everything we need but there's also value
in sticking to a single markup standard especially when someone has
contributed an outline in that.

I suppose my vote would be to accept
https://review.openstack.org/#/c/10487 and start building from there
but if someone wanted to contribute the equivalent in another markup I
wouldn't be opposed.

-Jon



More information about the Openstack-docs mailing list