<div dir="ltr"><div><div><div><div><div>Hi all,<br><br>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.<br>

<br></div>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.<br>

</div></div><br></div>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:<br> - completeness<br> - groupings (Is every option in the correct group? Are the groups right-sized?)<br>

<br></div>Anything else you want to know about this effort, please contact Tom Fifield or Steven Deaton or myself. <br><div><div><div><div><div><br></div><div>Thanks,<br>Anne<br></div><div><div><div><br>1. <a href="https://github.com/fifieldt/autogenerate-config-docs/" target="_blank">https://github.com/fifieldt/autogenerate-config-docs/</a><br>

2. <a href="https://review.openstack.org/#/c/28903/" target="_blank">https://review.openstack.org/#/c/28903/</a><br>3. <a href="https://review.openstack.org/#/c/28904/" target="_blank">https://review.openstack.org/#/c/28904/</a><br>

4. <a href="https://blueprints.launchpad.net/openstack-manuals/+spec/autogenerate-config-tables" target="_blank">https://blueprints.launchpad.net/openstack-manuals/+spec/autogenerate-config-tables</a> </div></div></div></div>

</div></div></div></div>