[openstack-dev] [all][docs][tc] How to scale Documentation

Maish Saidel-Keesing maishsk+openstack at maishsk.com
Sun Oct 5 06:51:31 UTC 2014


On 05/10/2014 06:00, Jay Pipes wrote:
> On 10/03/2014 09:18 PM, Zane Bitter wrote:
>> The prospect of a much larger tent with many more projects in
>> OpenStack-proper shines a spotlight on the scalability of the Docs team,
>> and in particular how they decide which projects are "important" to work
>> on directly.
>
> I don't believe that a ticket to live under the OpenStack tent should
> come with the expectation that the Docs team is required to write
> documentation for the project.
>
> IMHO, it should be up to the project itself to provide the resources
> to work *under the guidance* of the Docs team to write developer, end
> user and operator documentation. The Docs team members should be able
> to play an advisory role for new projects, helping them understand the
> automated doc processes, the way that common doc infrastructure works,
> and techniques for writing useful documentation consistent with other
> projects.
>
> Best,
> -jay
>
> _______________________________________________
> OpenStack-dev mailing list
> OpenStack-dev at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
A huge +1 on this!

You cannot expect the Docs team to understand and document a project -
on the project team knows the ins and outs of the code, what it can do,
and how to use it.

This does not mean it should be a free for all. Work *with* the the Docs
team to make the documentation standard and consistent across all of
OpenStack.

-- 
Maish Saidel-Keesing




More information about the OpenStack-dev mailing list