Agreed. For those plugins which are part of the Quantum distribution, we should provide documentation as well, of course. As stated by Dan, plugin-specific documentation could be linked from the "main" documentation pages.
For API extensions, they are too part of Quantum, and IMHO they deserve to be documented in the API documentation, even though they are plugin-specific. I think users will appreciate being able to browse all API documentation in a single point. The API documentation already contains a section on the extension framework (not the actual extensions). It would be nice to have appendixes documenting the extensions that we ship with Quantum, but I wouldn't be too much worried if we don't get this appendixes in time for the Diablo release. Salvatore From: Dan Wendlandt [mailto:d...@nicira.com] Sent: 14 September 2011 22:00 To: Ying Liu (yinliu2) Cc: Salvatore Orlando; netstack@lists.launchpad.net Subject: Re: [Netstack] Openstack API documentation - request for contribution Hi Ying, I'm actually dealing with some of the same questions with respect to the general quantum documentation. My thinking is that the main documentation will have certain points where there are links to external, plugin-specific documentation. For example, in the section about setting up Quantum, it would say "follow your plugin documentation to modify quantum/plugins.ini and perform other plugin-specific configuration". It would then have links plugin-specific pages for any plugin that ships with Quantum. With respect to API extensions, while you are under no obligation to document an extension that is specific to your plugin, I would say there definitely should be a way you can document this extension in the main documentation if that is what you would prefer. My hope is that many extensions will be written in a way that allows them to be adopted by other plugins + implementations if they prove both general and valuable. In that case, having the extension documented in a single public location is ideal. Dan On Wed, Sep 14, 2011 at 1:44 PM, Ying Liu (yinliu2) <yinl...@cisco.com<mailto:yinl...@cisco.com>> wrote: Hi Salvatore, Just want to double check with you. Vendor specific extension will not be added into this API documentation, right? If needed, we can provide that part. Otherwise, we will keep it within our document. Best, Ying From: netstack-bounces+yinliu2=cisco....@lists.launchpad.net<mailto:cisco....@lists.launchpad.net> [mailto:netstack-bounces+yinliu2<mailto:netstack-bounces%2Byinliu2>=cisco....@lists.launchpad.net<mailto:cisco....@lists.launchpad.net>] On Behalf Of Salvatore Orlando Sent: Wednesday, September 14, 2011 8:32 AM To: netstack@lists.launchpad.net<mailto:netstack@lists.launchpad.net> Subject: [Netstack] Openstack API documentation - request for contribution Hi Netstackers, While I'm completing the operation list on the API documentation book, I'd be glad if I could get some help into adding a section on extensions. Other <extendable> services, such as nova-compute, have a section describing how to fetch the extension list and details for each registered extensions. I think we should have a section for extension also in Quantum documentation; as our extension framework is "inspired" to nova's I think the documentation should be fairly similar; however we should probably add something to discuss plugin-aware extensions. I've drafted a section for extensions, which is attached to this email. It would be great if the guys which contributed the extension framework code (or used it to develop extensions) could have a look at this draft, and complete it. Thanks in advance, Salvatore -- Mailing list: https://launchpad.net/~netstack Post to : netstack@lists.launchpad.net<mailto:netstack@lists.launchpad.net> Unsubscribe : https://launchpad.net/~netstack More help : https://help.launchpad.net/ListHelp -- ~~~~~~~~~~~~~~~~~~~~~~~~~~~ Dan Wendlandt Nicira Networks, Inc. www.nicira.com<http://www.nicira.com> | www.openvswitch.org<http://www.openvswitch.org> Sr. Product Manager cell: 650-906-2650 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- Mailing list: https://launchpad.net/~netstack Post to : netstack@lists.launchpad.net Unsubscribe : https://launchpad.net/~netstack More help : https://help.launchpad.net/ListHelp
