[Openstack-docs] help with one of your review comments

Steve Gordon sgordon at redhat.com
Thu Nov 28 03:18:53 UTC 2013


----- Original Message -----
> From: "Dan Florea" <dan.florea at gmail.com>
> To: "Stephen Gordon" <sgordon at redhat.com>
> Sent: Tuesday, November 26, 2013 8:34:17 PM
> Subject: help with one of your review comments
> 
> Hi Stephen,
> 
> Regarding your comment in this review:
> 
> https://review.openstack.org/#/c/57791/
> 
> Can you point me to an example or provide some help on how to reference
> the autoconf table? My proposed doc includes a set of example
> instructions for configuration. I don't know where else they should go
> or where the autoconf table lives. But I'm more than happy to make the
> change as needed.
> 
> Thanks,
> Dan

I've somewhat waned on my opinion here, but the autodoc tools live under the tools directory in the openstack-manuals repository and generate the tables in the config-reference guide based on the configurations defined in the code of the relevant projects themselves.

So the upside is that by generating in this fashion they are less prone to get "stale" the downside is the resultant table(s) do not necessarily clearly illustrate a working config - though I don't necessarily think dumping one in the guide itself is always that helpful either - adding the replaceables at least makes it clear what needs to be changed though :).

Thanks,

Steve



More information about the Openstack-docs mailing list