Re: [openstack-dev] Doc for Trove ?
On 04/06/2014 08:32 PM, Anne Gentle wrote:
[...]
There is API documentation:
http://git.openstack.org/cgit/openstack/database-api/tree/openstack-database-api/src/markdown/database-api-v1.md
We should publish that one on docs.openstack.org
Andreas
--
Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126
___
OpenStack-dev mailing list
OpenStack-dev@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] Doc for Trove ?
On Sun, Apr 6, 2014 at 10:44 AM, Tim Bell tim.b...@cern.ch wrote: From my understanding, Trove is due to graduate in the Juno release. Since I didn't see it called out elsewhere in this thread yet, I'd like to point out that Trove graduated at the end of the Havana cycle and should be included in the integrated release of Icehouse. See http://git.openstack.org/cgit/openstack/governance/tree/reference/programs.yaml#n108 The questions you all have raised are very good ones, even though Trove was graduated before the new criteria were in place. These questions are also applicable to Ironic -- which is still incubated, aiming to graduate in the Juno release, does not yet have any content in the openstack docs repo, and is being held to the new requirements. Regards, Devananda ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] Doc for Trove ?
Tim Bell writes: 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) ? Hi Tim: Just to clarify, Trove graduated at the end of the Havana cycle, and has its first integrated release in IceHouse. Even though Trove graduated before the release criteria were put in place, we've worked to ensure that we are aligned with them. We've been tracking our progress against this at https://etherpad.openstack.org/p/TroveIntegrationRequirements. That said, docs is probably the one area that we still have a deficit in. We have Developer, API, and Client docs, but still need to do work on our deployment documentation. We have folks currently working on this, and hope to fill in this gap soon. Thanks, Nikhil ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] Doc for Trove ?
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.orghttp://docs.openstack.org, does that mean that the graduation status is delayed until K ? Tim On 4 Apr 2014, at 18:56, Anne Gentle anne.gen...@rackspace.commailto:anne.gen...@rackspace.com wrote: 4. New incoming doc requests: Lots of users want Trove documentation. ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] Doc for Trove ?
On Sun, Apr 6, 2014 at 12:44 PM, Tim Bell tim.b...@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, 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.gen...@rackspace.com wrote: 4. New incoming doc requests: Lots of users want Trove documentation. ___ 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
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/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.orghttp://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
Re: [openstack-dev] Doc for Trove ?
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:a...@openstack.org] Sent: 06 April 2014 20:33 To: OpenStack Development Mailing List (not for usage questions) Cc: Glen Campbell; openstack-d...@lists.openstack.org Subject: Re: [openstack-dev] Doc for Trove ? On Sun, Apr 6, 2014 at 12:44 PM, Tim Bell tim.b...@cern.chmailto:tim.b...@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.orghttp://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.gen...@rackspace.commailto:anne.gen...@rackspace.com wrote: 4. New incoming doc requests: Lots of users want Trove documentation. ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.orgmailto: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
Re: [openstack-dev] Doc for Trove ?
On Sun, Apr 6, 2014 at 1:45 PM, Tim Bell tim.b...@cern.ch wrote: 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/ ? Yes, since the Trove midcycle meetup in February we've had a writer at Tesora assigned to this task. It's a huge task though since we document four distros so all the helping hands we can get would be great. Thanks, Anne Tim *From:* Anne Gentle [mailto:a...@openstack.org] *Sent:* 06 April 2014 20:33 *To:* OpenStack Development Mailing List (not for usage questions) *Cc:* Glen Campbell; openstack-d...@lists.openstack.org *Subject:* Re: [openstack-dev] Doc for Trove ? On Sun, Apr 6, 2014 at 12:44 PM, Tim Bell tim.b...@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, 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.gen...@rackspace.com wrote: 4. New incoming doc requests: Lots of users want Trove documentation. ___ 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 ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] Doc for Trove ?
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.orghttp://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
Re: [openstack-dev] Doc for Trove ?
- Original Message - 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 In the ideal case it seems to me that the incubating project would be working on the documentation in a way that it can easily be dropped into openstack-manuals upon integration in the same way as support is dropped into Horizon. They would probably also need to be exposing builds of said documentation somewhere in the interim before moving into trunk as well. Currently though as far as I know the pre-incubation documentation is only worked up in the context of the developer site [1]. -Steve [1] http://docs.openstack.org/developer/trove/dev/install.html ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
