[openstack-dev] [docs][nova] config options help texts: reviews by technical writers?
Matt Kassawara
mkassawara at gmail.com
Mon Jul 18 14:03:19 UTC 2016
I think we can help. Do you want us to submit patches for config option
descriptions that benefit from rewording? Also, you might want to post to
the -docs list.
On Mon, Jul 18, 2016 at 6:29 AM, Markus Zoeller <mzoeller at linux.vnet.ibm.com
> wrote:
> I'd like to ask the docs team if they see the possibility to have
> reviews of the merged config options help texts Nova has updated in the
> last months.
>
> Background: In Mitaka and Newton, Nova put a lot of effort in providing
> valuable help texts for their config options. They are written from
> developers for operators. My assumption is, that technical writers like
> the docs team look at them differently. As these help texts get
> extracted from the code and will be used directly in the "configuration
> reference" manual, the text "by-passed" the writing expertise of the
> docs team.
>
> Be aware, that this is still an ongoing effort in Nova (see [1],
> especially "needs:fix_opt_description").
>
> References:
> [1] http://45.55.105.55:8082/config-options.html
>
> --
> Regards, Markus Zoeller (markus_z)
>
>
> __________________________________________________________________________
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
> 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/20160718/bc936280/attachment.html>
More information about the OpenStack-dev
mailing list