Open Stack

Hi Michael,

Let me add openstack-docs mailing list.

On 12/12/2013 02:08 AM, Michael Chapman wrote:
Hi all,

Since we (Cisco) have recently switched over to using hiera and away
from the puppet-openstack control/compute classes, we have a lot more
flexibility in setting parameters per-class via yaml. This has lead to
my realisation that we have no reference documentation on what
parameters are available, and this is making construction of user-facing
doc quite difficult.

I've got a little script here that pulls in all the classes that are
used by puppet_openstack_builder and generates RDoc:
https://review.openstack.org/#/c/61296/1/doc/build_doc.sh

> Most of the newer modules and classes are documented correctly, but
> the nova module in particular is very lacking.
>
> I'd like some input from the community and hopefully Puppetlabs on a
> couple of things:
>
>  - First, is anyone doing this already and am I wasting my time?
Not from our side.
>  - Second, does anyone have an opinion on where we could host doc?
As an OpenStack manual contributor, I wonder if we could use
docs.openstack.org. That's why I CC the ML, and I would like to have
feedback from Anne Gentle.
>
> Does PL have a place for reference doc for modules that are in the
> forge? If not, could we put a section in openstack-manuals, and
> failing both of those should I just buy puppet-openstack.com
> <http://puppet-openstack.com> and host it myself?
>
> I'm also thinking about a gating job that checks all parameters are
> documented, but that's a ways off.
+1 for gating, it would ensure good coverage of documentation also.
>
>  - Michael
>

Thank you Michael to bringing that!

Emilien Macchi



-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20131212/8ceb8edb/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 555 bytes
Desc: OpenPGP digital signature
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20131212/8ceb8edb/attachment.pgp>