[openstack-dev] [Ceilometer] Documentation and patches

Anne Gentle annegentle at justwriteclick.com
Sun Sep 1 13:02:37 UTC 2013


On Sat, Aug 31, 2013 at 9:09 AM, Lorin Hochstein
<lorin at nimbisservices.com>wrote:

>
> On Fri, 30 Aug 2013 08:33:40 -0500, Anne Gentle wrote:
>
>
> I applaud Julien's note and we're happy to work with the teams on finding
> where docs should go. Julien's feeling very behind, and I'm sure other
> projects are feeling the same.
>
> We all have to set priorities. Here's where I'd start.
>
> Log doc bugs in openstack-manuals for:
> installation
> configuration
> day-to-day running
> end-user tasks
> admin tasks
> troubleshooting
>
> Log doc bugs in openstack-api-site for:
> API reference docs
>
>
>
> Would it help  if doc bugs were associated with the relevant OpenStack
> project, in addition to the openstack-manauls project? For example, we
> could mark nova-related doc bugs as "nova" project bugs in addition to
> "openstack-manuals" project bugs.
>

I like this idea and it seems fairly trivial to do automatically -- teams,
unless you see a big problem with this approach I'll patch the DocImpact
automation tool on Monday.

Anne

>
> This would make outstanding doc issues more visible to the relevant devs,
> and would reinforce the idea that missing/incorrect documentation in, say,
> nova should be viewed as a *nova* issue and not simply a *documentation*
> issue. In particular, it could generate more doc-focused effort when it
> comes time for the pre-release bug squashing activities, since devs will be
> encouraged to squash those bugs in their project.
>
> Take care,
>
> Lorin
> --
> Lorin Hochstein
> Lead Architect - Cloud Services
> Nimbis Services, Inc.
> www.nimbisservices.com
>
>
> _______________________________________________
> OpenStack-dev mailing list
> OpenStack-dev at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>
>


-- 
Anne Gentle
annegentle at justwriteclick.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20130901/ec04c47a/attachment.html>


More information about the OpenStack-dev mailing list