Open Stack

On Sun, Apr 6, 2014 at 1:40 PM, Steve Gordon <sgordon at redhat.com> wrote:

> ----- Original Message -----
> >
> > Anne,
> >
> > From my understanding, Trove is due to graduate in the Juno release.
> >
> > Is documentation for developers, operators and users not one of the
> criteria
> > (
> http://git.openstack.org/cgit/openstack/governance/tree/reference/incubation-integration-requirements
> )
> > ?
> >
> >
> > * Documentation / User support
> > ** Project must have end-user docs such as API use, CLI use, Dashboard
> use
> > ** Project should have installation docs providing install/deployment in
> an
> >    integrated manner similar to other OpenStack projects, including
> >    configuration reference information for all options
> > ** Project should have a proven history of providing user support (on the
> >    openstack@ mailing list and on Ask OpenStack)
> >
> >
> >
> > If this is not provided in time for the Juno release on
> > docs.openstack.org<http://docs.openstack.org>, does that mean that the
> > graduation status is delayed until K ?
> >
> > Tim
>
> There seems to be a bit of a chicken and egg problem here, in that
> documentation isn't typically accepted into openstack-manuals until the
> relevant project is officially moved to integrated by the TC.


Yes, we have several issues to work through. A few off the top of my head:

- The OpenStack community needs project teams to scale their doc efforts
towards end users and deployers.
- Trove is the first project being placed in the scrutiny of the new
integration graduation requirements. Heat and Ceilometer were integrated
prior to these requirements being outlined.
- The core docs team has not "signed up" for non-core projects based on our
mission statement.
- Probably other issues I'm forgetting but please fill them in. :)

It's a tough problem to unknot for sure, we all need to work towards what
we want here and what it's going to take to get what we all want.
Thanks,
Anne


> As a result there's a limited amount of time to integrate any
> documentation the project is carrying separately into the formal guides.
>
> Specifically speaking of Trove some of the low hanging fruit is done:
>
> * Configuration Reference:
> http://docs.openstack.org/trunk/config-reference/content/ch_configuring-trove.html
> * Command Line Reference:
> http://docs.openstack.org/cli-reference/content/troveclient_commands.html
>
> But by my reckoning that means we're still missing coverage of the
> following content in the official documentation project:
>
> * trove coverage in the installation guide ("Add the X module" - similar
> to what we have for Orchestration and Telemetry)
> * end user documentation
> * API documentation
>
> Thanks,
>
> Steve
>
> _______________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20140406/47cafbf9/attachment.html>