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

Anita Kuno anteaya at anteaya.info
Wed Sep 2 18:48:02 UTC 2015


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

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.

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
> 

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.22 (GNU/Linux)

iQEcBAEBAgAGBQJV50RhAAoJELmKyZugNFU0X1sIANlLUwxe8i+vlRISuPQFBzWR
a8h4VybYRz1kz64LthKbwYaX5yRGyyn5ir0BbwC4cvxaN1J8P46/hJ7lAEe3BxWL
t5hqPdL40xSNcBLLX8EaJPS1ohO9V13k/qFstbWu3pF0tXYcqRiX53X1pS7v8VpL
19qXElddTTu9Nn6NAGeJS8fL/h5N67dBC0/S2K0kEHaXQI7yRB2uvUSwOsWQTswC
s/XVuGy/wQgHESbIEaiNgk49BjMm+5bYB187hJa97SuIjsGyIcUZsz44nZcyjlbv
cAmhhjkxgtFgM2znGuYXJGb5CKfZn+1qFgNhDGxFuQhFUuxRpRyaxkGLxq1fGaw=
=rk94
-----END PGP SIGNATURE-----



More information about the OpenStack-dev mailing list