Open Stack

On Wed, Jun 25, 2014 at 7:32 PM, Nikhil Manchanda <nikhil at manchanda.me>
wrote:

>
> Hi Anne:
>
> Thanks for bringing this to our attention! This is definitely something
> that we need to fix.
>
> I've filed https://bugs.launchpad.net/trove/+bug/1334465 to track this
> issue, and I'm hoping we'll be able to get to it during juno-2 (or
> beginning of juno-3 at the latest).
>
> Once we've got a patch up, I'll probably run it by some doc folks to
> make sure that the help text for the options reads okay. Would
> appreciate the feedback here.
>
>
Thanks! I forgot to mention, we do have a style guide for writing config
options:
http://docs.openstack.org/developer/oslo.config/styleguide.html

Also I failed to mention that the swift options descriptions are pulled
from the example config files, so those are what need updating.

Thanks,
Anne



> Thanks,
> Nikhil
>
> Anne Gentle writes:
>
> > Hi swift and trove devs,
> > In working on our automation to document the configuration options across
> > OpenStack, we uncovered a deficit in both trove and swift configuration
> > option descriptions.
> >
> > Here's an example:
> >
> http://docs.openstack.org/trunk/config-reference/content/container-sync-realms-configuration.html
> > You'll notice that many of those options do not have help text. We need
> > swift developers to fill in those in your code base so we can continue to
> > generate this document.
> >
> > Trove devs, we are finding similar gaps in config option information in
> > your source code as well. Please make it a priority prior to our
> automating
> > those in the docs.
> >
> > If you have any questions, let us know through the openstack-docs mailing
> > list.
> > Thanks,
> > Anne
> > _______________________________________________
> > OpenStack-dev mailing list
> > OpenStack-dev at lists.openstack.org
> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>
> _______________________________________________
> 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/20140625/478715b7/attachment.html>