[openstack-dev] Doc for Trove ?

Tim Bell Tim.Bell at cern.ch
Sun Apr 6 18:45:12 UTC 2014


Anne,

Thanks... pleased to see the documentation is in the pipeline, gaps raised with the TC and that this is not left as an optional afterthought.

Is it planned to add something to the installation guides (as for the other projects) such as http://docs.openstack.org/trunk/install-guide/install/yum/content/ ?

Tim

From: Anne Gentle [mailto:anne at openstack.org]
Sent: 06 April 2014 20:33
To: OpenStack Development Mailing List (not for usage questions)
Cc: Glen Campbell; openstack-docs at lists.openstack.org
Subject: Re: [openstack-dev] Doc for Trove ?



On Sun, Apr 6, 2014 at 12:44 PM, Tim Bell <Tim.Bell at cern.ch<mailto:Tim.Bell at cern.ch>> wrote:

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 ?

Hi Tim,
We have trove on the agenda for review at the next TC meeting. https://wiki.openstack.org/wiki/Governance/TechnicalCommittee

Here's what I know is completed for docs, as well as what is needed to be done:

Needs:
There is a writer at Tesora working on adding Trove to the install guides. *
API reference info to be added to http://api.openstack.org/api-ref.html through the api-site/api-ref/ process. *
We still need a section added to the Virtual Machine Image Guide so that deployers know how to make DBaaS (trove) work for their users:
http://docs.openstack.org/image-guide/content/ *
I don't see an indicator of Dashboard use in the docs. This would go into the End User Guide or Admin User Guide. *

There is configuration reference doc:
http://docs.openstack.org/trunk/config-reference/content/ch_configuring-trove.html

There is command-line interface reference:
http://docs.openstack.org/cli-reference/content/troveclient_commands.html

There is API documentation:
http://git.openstack.org/cgit/openstack/database-api/tree/openstack-database-api/src/markdown/database-api-v1.md

There is contributor dev doc at:
http://docs.openstack.org/developer/trove/

Thanks for asking, Tim.
Anne

* Indicates a gap and need in the docs.


Tim

On 4 Apr 2014, at 18:56, Anne Gentle <anne.gentle at rackspace.com<mailto:anne.gentle at rackspace.com>> wrote:




4. New incoming doc requests:

Lots of users want Trove documentation.



_______________________________________________
OpenStack-dev mailing list
OpenStack-dev at lists.openstack.org<mailto:OpenStack-dev at lists.openstack.org>
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20140406/1eaba4f1/attachment.html>


More information about the OpenStack-dev mailing list