Open Stack

Andreas,

I receive quite a few complaints that our automatic documentation merely
copies help strings in the code instead of providing additional
information. We could ask developers to provide additional information in
the help strings, but it would cause large example configuration files or
excessive CLI output. So, I made a suggestion at the summit (with Doug) to
split help strings into short and long versions. The short version would
appear in example configuration files or CLI output and the long version
would appear in our automatic documentation.

On Tue, May 10, 2016 at 1:33 AM, Andreas Jaeger <aj at suse.com> wrote:

> At the OpenStack summit we discussed whether and how to use oslo.config
> directly to generate configuration options for the Configuration Reference.
>
> One idea was to move the flagmappings to the project repositories and
> let them maintain it.
>
> Is anybody interested in working with Doug on this? First Doug needs to
> understand our requirement - so writing those up would be the first part.
>
> Andreas
> --
>  Andreas Jaeger aj@{suse.com,opensuse.org} Twitter: jaegerandi
>   SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
>    GF: Felix Imendörffer, Jane Smithard, Graham Norton,
>        HRB 21284 (AG Nürnberg)
>     GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126
>
>
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20160510/97392f04/attachment.html>