[OpenStack-docs] [Contributor guide] Update and questions

Olga Gusarenko ogusarenko at mirantis.com
Tue Oct 13 08:30:58 UTC 2015


Thanks much for your replies, we will proceed as discussed.

Best, Olga



On Mon, Oct 12, 2015 at 3:18 PM, Andreas Jaeger <aj at suse.com> wrote:

> On 2015-10-12 13:43, Olga Gusarenko wrote:
>
>> Hi all,
>>
>> The Contributor guide is almost ready to be published.
>>
>> We have several commits on review at the moment. They are:
>>
>>   * https://review.openstack.org/#/c/232966/
>>   * https://review.openstack.org/#/c/233183/
>>   * some information from the HowTo conventions page will be available
>>     on review in a day.
>>
>> *Your reviews are welcome.*
>>
> >
>
>> Therefore, we would like to know the next steps to take to have the
>> guide published.
>>
>>  >> /Andreas suggests the following solutions/:
>>  >> On a technical level: Update tools/build-all-rst.sh so that it does
>> not get published at /draft/ and update all index.html pages.
>>  >> On a process level: Once those changes are in, I suggest we do a one
>> week review of the content (still as draft) and afterwards to the
>> technical change.
>>  >> We do not need to wait for Liberty, we can publish and announce
>> anytime we think we're ready.
>>
>
>
> One addition: Once you have everything in, rework the wiki pages so that
> they are empty and just link/redirect to the new contributor guide.
>
> Another question is about DocBook markup. I suggest leaving the related
>> conventions as they are (on wiki), and create a separate page in the
>> Contributor guide with the information that the DocBook markup is
>> deprecated at the moment but if users need it they can refer
>> tohttps://wiki.openstack.org/wiki/Documentation/Markup_conventions
>> <https://wiki.openstack.org/wiki/Documentation/Markup_conventions>.
>> What do you think?
>>
>>  >> /from Andreas/:
>>  >>Works for me.
>>
>> *Your thoughts and ideas regarding the matter are very much appreciated!*
>>
>
> Andreas
> --
>  Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
>   SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
>    GF: Felix Imendörffer, Jane Smithard, Graham Norton,
>        HRB 21284 (AG Nürnberg)
>     GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126
>
>


-- 
Best regards,
Olga

Technical Writer
skype: gusarenko.olga
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20151013/1d2df563/attachment.html>


More information about the OpenStack-docs mailing list