Open Stack

Gauvain,

This is the most appropriate place
http://docs.openstack.org/contributor-guide/rst-conv/source-code.html

Olga

On Thu, Dec 3, 2015 at 9:20 AM, Gauvain Pocentek <
gauvain.pocentek at objectif-libre.com> wrote:

>
>
> Le 2015-12-02 13:45, Olena Logvinova a écrit :
>
>> At the moment I am not sure if I like it or not. But I think the
>>> usage of custom RST directives should be discussed on the list and if
>>> we decide to use custom RST directives they should be documented in
>>> the contributor guide.
>>>
>>
>> I like the way a document looks like if we use this directive - it
>> becomes smaller and, therefore, looks nicer. =)
>> So I vote for adding this directive to the Contributor Guide conventions.
>>
>
>
> I'm not yet familiar with the contributor guide. Where do you suggest I
> should add this?
>
> Thanks,
> Gauvain
>
>
>
>> Thanks
>> Olena
>>
>> On Wed, Dec 2, 2015 at 1:17 PM, Gauvain Pocentek
>> <gauvain.pocentek at objectif-libre.com> wrote:
>>
>> Le 2015-12-02 11:31, Christian Berendt a écrit :
>>>
>>> Hello everybody.
>>>>
>>>> While reviewing a review request for the new config-rst-guide I saw
>>>> the usage of the RST directive "remote-code-block". I never saw this
>>>> directive before and after searching for the definition I only found
>>>>
>>>> https://github.com/openstack/openstack-manuals/blob/master/doc/config-ref-rst/source/ext/remote.py#L19
>>>> [1].
>>>>
>>>
>>> This particular directive tries to reproduce the docbook <xi:include>
>>> behaviour, to avoid adding loads of sample file in our tree. I'm guilty of
>>> adding it to the config-ref-rst folder.
>>>
>>> At the moment I am not sure if I like it or not. But I think the
>>>> usage of custom RST directives should be discussed on the list and if
>>>> we decide to use custom RST directives they should be documented in
>>>> the contributor guide.
>>>>
>>>
>>> Agreed. To be honnest I planned to write to the ML but it just slipped
>>> my mind.
>>>
>>> Gauvain Pocentek
>>>
>>> Objectif Libre - Infrastructure et Formations Linux
>>> http://www.objectif-libre.com [2]
>>>
>>> _______________________________________________
>>> OpenStack-docs mailing list
>>> OpenStack-docs at lists.openstack.org
>>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs [3]
>>>
>>
>> --
>>
>> Best regards,Olena Logvinova,
>> Technical Writer | Mirantis, Kharkiv | 38, Lenin av., Kharkiv
>> ologvinova at mirantis.com | +380950903196 [4]
>>
>> Links:
>> ------
>> [1]
>>
>> https://github.com/openstack/openstack-manuals/blob/master/doc/config-ref-rst/source/ext/remote.py#L19
>> [2] http://www.objectif-libre.com
>> [3] http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>> [4] tel:%2B380950903196
>>
>
> Gauvain Pocentek
>
> Objectif Libre - Infrastructure et Formations Linux
> http://www.objectif-libre.com
>
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>



-- 
Best regards,
Olga Gusarenko

Technical Writer | Mirantis, Kharkiv | 38, Lenin av., Kharkiv, Ukraine
ogusarenko at mirantis.com | skype: gusarenko.olga | +38 (050) 843-14-25
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20151203/245f2d83/attachment.html>