[openstack-dev] Automatic documentation plan

Doug Hellmann doug.hellmann at dreamhost.com
Fri May 24 18:32:33 UTC 2013


This work Julien is doing to produce default config files may also be
interesting:

https://review.openstack.org/#/c/30426/

Doug


On Fri, May 24, 2013 at 2:12 PM, Anne Gentle <anne at openstack.org> wrote:

> Hi all,
>
> I wanted to let you all know we've got a blueprint for the docs group that
> automates configuration reference information. Tom Fifield and Steven
> Deaton have been spearheading this effort. Their work so far is in [1] and
> the doc team is reviewing the resulting docs in patches [2] [3]. This
> supports the work in a docs blueprint [4]. The idea is to automate pulling
> the doc strings into tables for easy lookup in the documentation. Likely
> the result will be output as "Configuration Reference Guides" initially,
> with the goal of producing accurate lists at each milestone release,
> culminating in a go-to list for each six-month release. The tool itself
> will sit in the openstack-manuals/tools directory.
>
> What does this mean for you? If you're a developer write the best
> description you can for the docstrings for items that go into .conf files.
> If you're a code reviewer, be on the lookout for patches that clean those
> up.
>
> We also want input from deployers on how best to introduce each
> configuration table with useful information. Please also take a look at the
> patches and review for:
>  - completeness
>  - groupings (Is every option in the correct group? Are the groups
> right-sized?)
>
> Anything else you want to know about this effort, please contact Tom
> Fifield or Steven Deaton or myself.
>
> Thanks,
> Anne
>
> 1. https://github.com/fifieldt/autogenerate-config-docs/
> 2. https://review.openstack.org/#/c/28903/
> 3. https://review.openstack.org/#/c/28904/
> 4.
> https://blueprints.launchpad.net/openstack-manuals/+spec/autogenerate-config-tables
>
> _______________________________________________
> OpenStack-dev mailing list
> OpenStack-dev at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20130524/f86a6896/attachment.html>


More information about the OpenStack-dev mailing list