My worry is that many deployers are waiting for programs to reach integrated before looking at them in detail. When something is announced as integrated, there is an expectation that the TC criteria are met.
When there is no installation documentation or end user CLI or dashboard information, it can give a negative experience that delays deployment significantly. Can we find a way that the incubation documentation can be provided for those who are interested in testing both the code and the documentation in the different environments. Thus, like the code, this should naturally follow a release candidate cycle so we can all give input on documentation content as well as functionality. Tim > -----Original Message----- > From: Steve Gordon [mailto:sgor...@redhat.com] > Sent: 06 April 2014 20:40 > To: OpenStack Development Mailing List (not for usage questions) > Cc: Glen Campbell; openstack-d...@lists.openstack.org > Subject: Re: [openstack-dev] Doc for Trove ? > > ----- 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/inc > > ubation-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. 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-dev mailing list > OpenStack-dev@lists.openstack.org > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev _______________________________________________ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
