[openstack-dev] [puppet] hosting developer documentation on http://docs.openstack.org/developer/
Anita Kuno
anteaya at anteaya.info
Fri Sep 4 15:51:58 UTC 2015
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
On 09/04/2015 09:28 AM, Emilien Macchi wrote:
>
>
> 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/ove
rview.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.
Here is a patch: https://review.openstack.org/#/c/220555/
I still need to offer the co-responding patch to the governance repo.
Thanks,
Anita.
>
>>
>> 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
>>
>
>>
>
>
> ______________________________________________________________________
____
>
>
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
>
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.22 (GNU/Linux)
iQEcBAEBAgAGBQJV6b4eAAoJELmKyZugNFU0oIAH/Atinp6F+2/fF/rOJXRSAY1q
CMprTm2x0eNGDTH/Cy17U305qj4cSXdzcpv3yv7iLDQRFcSCvWwzcTXxmUjIKrRe
1n8EI+vi/kg/MoSMBSAk84o6Zt9YM2pTbIr/rFzvb0qEesx7r2eErV6lpRJbpUvm
qFU0+GBBoDJi5DN2T1Y4qV3MhgxNJLpJfzorT4Nn4AAGXqWSvKM1y1YEtTIiK0wn
d7VoWdcffDI4/hPyMnjOngKf0mj5v66KJkL6eYrY9InqMrCTjwg0v6YlQ+gp3wHw
oZWe34WDU/DPQBJyhq7UOcK0khnHIvfJorCo1lOz2V3uZE5g+NBB8Z9dBTlfbvk=
=Ju1R
-----END PGP SIGNATURE-----
More information about the OpenStack-dev
mailing list