[openstack-dev] [puppet] hosting developer documentation on http://docs.openstack.org/developer/

Emilien Macchi emilien at redhat.com
Fri Sep 4 13:28:47 UTC 2015



On 09/03/2015 03:00 PM, Emilien Macchi wrote:
> 
> 
> On 09/02/2015 02:56 PM, Emilien Macchi wrote:
>>
>>
>> On 09/02/2015 02:48 PM, Anita Kuno wrote:
>>> On 09/02/2015 02:09 PM, Emilien Macchi wrote:
>>>> TL;DR, I propose to move our developer documentation from wiki to 
>>>> something like 
>>>> http://docs.openstack.org/developer/puppet-openstack
>>>
>>>> (Look at http://docs.openstack.org/developer/tempest/ for 
>>>> example).
>>>
>>> Looking at the tempest example:
>>> http://git.openstack.org/cgit/openstack/tempest/tree/doc/source
>>> we see that the .rst files all live in the tempest repo in doc/source
>>> (with the exception of the README.rst file with is referenced from
>>> within doc/source when required:
>>> http://git.openstack.org/cgit/openstack/tempest/tree/doc/source/overview.rst)
>>>
>>> So question: Where should the source .rst files for puppet developer
>>> documentation live? They will need a home.
>>
>> I guess we would need a new repository for that.
>> It could be puppet-openstack-doc (kiss)
>> or something else, any suggestion is welcome.
> 
> Are we ok for the name?
> proposal:
> puppet-openstack-doc
> puppet-openstack-documentation

Let's go for puppet-openstack-docs.

> 
> Any suggestion is welcome,
> 
>>>
>>> Thanks,
>>> Anita.
>>>
>>>
>>>> For now, most of our documentation is on 
>>>> https://wiki.openstack.org/wiki/Puppet but I think it would be 
>>>> great to use RST format and Gerrit so anyone could submit 
>>>> documentation contribute like we do for code.
>>>
>>>> I propose a basic table of contents now: Puppet modules 
>>>> introductions Coding Guide Reviewing code
>>>
>>>> I'm taking the opportunity of the puppet sprint to run this 
>>>> discussion and maybe start some work of people agrees to move on.
>>>
>>>> Thanks,
>>>
>>>
>>>
>>>> __________________________________________________________________________
>>>
>>>
>>>
>>> OpenStack Development Mailing List (not for usage questions)
>>>> Unsubscribe: 
>>>> OpenStack-dev-request at lists.openstack.org?subject:unsubscribe 
>>>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>>>
>>>
>>>
>>> __________________________________________________________________________
>>> OpenStack Development Mailing List (not for usage questions)
>>> Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
>>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>>>
>>
>>
>>
>> __________________________________________________________________________
>> OpenStack Development Mailing List (not for usage questions)
>> Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>>
> 
> 
> 
> __________________________________________________________________________
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
> 

-- 
Emilien Macchi

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 473 bytes
Desc: OpenPGP digital signature
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20150904/30e1cf6f/attachment.pgp>


More information about the OpenStack-dev mailing list