[Openstack-docs] Operations Manual.

Williams-Cauley, Debra Debra.J.Williams at pearson.com
Thu Aug 16 20:21:25 UTC 2012


The final manuscript for the book project can be delivered in either Docbook
or Sphinx. I will have authoring teams work in whatever is most convenient
and then convert files at the end. Just keep me posted, happy to help.

Debra


> From: Anne Gentle <anne at openstack.org>
> Date: Sun, 12 Aug 2012 10:48:51 -0400
> To: Jonathan Proulx <jon at jonproulx.com>
> Cc: Doug Hellmann <doug.hellmann at gmail.com>, "Williams-Cauley, Debra"
> <Debra.J.Williams at pearson.com>, <openstack-docs at lists.openstack.org>
> Subject: Re: [Openstack-docs] Operations Manual.
> 
> On Fri, Aug 10, 2012 at 10:30 AM, Jonathan Proulx <jon at jonproulx.com> wrote:
>> On Mon, Aug 6, 2012 at 11:50 AM, Doug Hellmann <doug.hellmann at gmail.com>
>> wrote:
>> 
>>> I have a bit of experience with DocBook, and IIRC it was an option with
>>> Pearson. My book was done with Sphinx and LaTeX with only moderate pain
>>> during the compositing phase.
>> 
>>> Anything that makes merging and collaborating easy works for me. What tools
>>> are the group used to working with?
> 
> Hi Doug, for working on OpenStack docs, you can get an Oxygen license
> for free which should make editing DocBook fairly fast and efficient.
> 
> You can author with validation in emacs, if you don't want a separate
> tool to launch. I've updated the
> http://wiki.openstack.org/Documentation/HowTo page with links about
> how to configure emacs to validate XML if you would want to go that
> route.
> 
> As far as the collaboration stuff, it's all just like code projects
> with Launchpad/Git/Gerrit/Jenkins as tool at the heart of the
> processing.
> 
> Can't wait to see some patches for the operations manual!
> 
> Anne
> 
>> Hi Doug,
>> 
>> If you're going to be putting major hours into this I'm personally
>> happy to leave the choice of tools to you. So if you'd rather use
>> Sphinx and LaTeX let's go for that, if it's all the same I think the
>> default path forward is what Anne suggested as a possibility:
>> 
>>>> I think one good path is:
>>>> 1. Un-abandon review 10487.
>>>> 2. In the book file make sure CC licensing is set.
>>>> 3. Start writing based on the outline.
>>>> 4. Rock out.
>>>> 5. Do maintenance going forward in a common authoring environment.
>> 
>> -Jon




More information about the Openstack-docs mailing list