[OpenStack-docs] Creating a new guide in RST

Anne Gentle annegentle at justwriteclick.com
Mon Feb 2 18:40:26 UTC 2015


On Mon, Feb 2, 2015 at 12:38 PM, Nick Chase <nchase at mirantis.com> wrote:

> Definitely helpful. so we just need to conform to the structure, and
> people able to read internally. Correct?
>

Read internally sounds funny today for some reason, but read locally yes.
:) The outline and structure can be in the index.rst also for the local
builds so that sounds correct.


> On Feb 2, 2015 1:21 PM, "Anne Gentle" <annegentle at justwriteclick.com>
> wrote:
>
>>
>>
>> On Mon, Feb 2, 2015 at 11:49 AM, Nick Chase <nchase at mirantis.com> wrote:
>>
>>>  So that talks about conventions and stuff; I was referring to the
>>> process of creating "new" book in RST.  So should I assume that if we just
>>> structure the comment like the other RST-based guides the tooling will
>>> handle the rest, or is there something else we need to do?
>>>
>>>
>> If you want to publish prior to April, you'll want to stay with DocBook
>> while we get the entire toolchain built out (builds, CI, translation,
>> etc.). We need:
>> - landing pages to merge
>> - openstackdocstheme released
>> - translation slicing and po file mapping completed
>>
>> If you just want to get it into RST to increase contribution and have
>> people read on Github, that's also fine. Just don't expect all of CI
>> completed for a while.
>>
>> At the state your manual is in, I think it's fine to get it in RST and
>> have people build locally for reviews.
>>
>> Does that help?
>> Anne
>>
>>
>>
>>> Thanks...
>>>
>>> ----  Nick
>>>
>>> On 1/30/2015 10:08 PM, Anne Gentle wrote:
>>>
>>> Yes, I just sent out the wiki link in today's "What's Up Doc?" -- see
>>>
>>>  https://wiki.openstack.org/wiki/Documentation/Migrate
>>>
>>>  Please update as you see more conventions that need to be added.
>>>
>>>  Thanks -
>>> Anne
>>>
>>> On Fri, Jan 30, 2015 at 9:03 PM, Nick Chase <nchase at mirantis.com> wrote:
>>>
>>>> We've decided to convert the networking guide to RST.  Have we got the
>>>> process of creating an RST book documented anywhere?
>>>>
>>>> Thanks...
>>>>
>>>> ----  Nick
>>>>
>>>> _______________________________________________
>>>> OpenStack-docs mailing list
>>>> OpenStack-docs at lists.openstack.org
>>>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>>>>
>>>
>>>
>>>
>>>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20150202/d7cc1959/attachment.html>


More information about the OpenStack-docs mailing list