[Openstack-docs] Review request: doc contribution survey
Anne Gentle
anne at openstack.org
Thu Apr 3 15:18:41 UTC 2014
Hi all,
Some changes are now available based on input, thanks for taking a look!
Keep it coming, I can keep making changes for the next 8 hours or so.
Thanks,
Anne
On Wed, Apr 2, 2014 at 2:46 PM, Anne Gentle <anne at openstack.org> wrote:
> Hi all,
> We all want to increase the number of doc contributors while still
> producing and maintaining quality documentation for OpenStack. I want to
> gather data from our community about what limits people from contributing
> to documentation.
>
> I've put together this survey [1] and I would like to send it out by
> Friday this week. Can you take a few minutes to review and offer input by
> 22:00 UTC Thursday (tomorrow)? What questions am I not asking? Are these
> worded in such a way that we'll get actionable data?
>
> Thanks for your help and interest in this area!
> Anne
> [1]
> https://docs.google.com/forms/d/136-BssH-OxjVo8vNoOD-gW4x8fDFpvixbgCfeV1w_do/edit?usp=sharing
>
> Have you contributed to OpenStack Documentation in the last year? *
> You contributed if you made a patch to your <project>/doc folder,
> openstack-manuals, api-site, object-api, image-api, identity-api,
> compute-api, volume-api, netconn-api, operations-guide, or database-api or
> if you reviewed a patch or if you logged a doc bug for openstack-manuals or
> openstack-api-site. Whew!
>
> - Yes
> - No
> - I don't know; what counts as a doc contribution?
>
> If you've contributed, how did you do so? *
> Check all that apply
>
> - Created and landed a patch for openstack-manuals
> - Created and landed a patch for api-site or <project>-api
> - Created and landed a patch for a <project>/doc developer doc
> - Created but didn't land a patch
> - Reviewed a doc patch
> - Logged a doc bug
>
> What obstacles prevent you from contributing to OpenStack documentation?
> Check all that apply
>
> - The git/gerrit workflow stumps me and isn't in my normal work
> environment
> - I'm allergic to DocBook and WADL because XML
> - My team doesn't value documentation like code so why bother
> - Documentation writing is not interesting to me
> - Every time I want to contribute to docs, I can't figure out where
> to put the thing I know
> - I didn't think I knew enough to contribute to official OpenStack
> documentation
> - My project is incubating so it's outside of the OpenStack
> documentation mission
> - When I've tried to patch documentation, the review process got me
> down, too long, too nit-picky, or too many cooks in the kitchen on my patch
> - The doc tools themselves are heavy handed, prescriptive, and too
> opinionated
> - Testing doc patches requires an OpenStack environment I don't have
> set up or access to in a lab
> - I think someone else should write the documentation, not me
> - I would only contribute documentation if I were paid to do so; it
> isn't a volunteer effort
> - Other:
>
> Generally does your team value documentation for contributors? For
> deployers? For end-users?
>
> - Yes, of course
> - Honestly, no
> - Wait, is this a trick question?
> - Yes, but only one of those audiences:
> - Other:
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20140403/4fdd8ed8/attachment.html>
More information about the Openstack-docs
mailing list