Re: [openstack-dev] [Neutron] Docs for new plugins
On Wed, Mar 19, 2014 at 12:45 AM, Edgar Magana emag...@plumgrid.com wrote: Including Anne in this thread. Anne, Can your provide your input here? Thanks, Edgar From: Mohammad Banikazemi m...@us.ibm.com Reply-To: OpenStack List openstack-dev@lists.openstack.org Date: Monday, March 17, 2014 8:02 AM To: OpenStack List openstack-dev@lists.openstack.org Subject: Re: [openstack-dev] [Neutron] Docs for new plugins I think the docs get updated for each release, so probably the newly added stuff (after I3) will be picked up by the RC1 release date. (cc'ing Tom Fifield for a definitive answer.) By the way I do see the odl config table in the openstack-manuals source tree: https://github.com/openstack/openstack-manuals/blob/master/doc/common/tables/neutron-ml2_odl.xml and that is being referenced here: https://github.com/openstack/openstack-manuals/blob/master/doc/config-reference/networking/section_networking-plugins-ml2.xml Best, Mohammad [image: Inactive hide details for Kyle Mestery ---03/17/2014 09:40:51 AM---Edgar: I don't see the configuration options for the OpenDay]Kyle Mestery ---03/17/2014 09:40:51 AM---Edgar: I don't see the configuration options for the OpenDaylight ML2 Hi Kyle, there is still a manual step by a docs person to run the scripts and create a patch. Does Gauvain's patch contain the OpenDaylight config options? https://review.openstack.org/#/c/81013/ I also want to note that just because there is reference information doesn't mean the docs are complete -- are there concepts and tasks still to be written so that users know how to use this ML2 plug-in and that it's available? Add those to the Cloud Administration Guide please. Thanks, Anne From: Kyle Mestery mest...@noironetworks.com To: OpenStack Development Mailing List (not for usage questions) openstack-dev@lists.openstack.org, Date: 03/17/2014 09:40 AM Subject: Re: [openstack-dev] [Neutron] Docs for new plugins -- Edgar: I don't see the configuration options for the OpenDaylight ML2 MechanismDriver added here yet, even though the code was checked in well over a week ago. How long does it take to autogenerate this page from the code? Thanks! Kyle On Wed, Mar 12, 2014 at 5:10 PM, Edgar Magana *emag...@plumgrid.com*emag...@plumgrid.com wrote: You should be able to add your plugin here: *http://docs.openstack.org/havana/config-reference/content/networking-options-plugins.html*http://docs.openstack.org/havana/config-reference/content/networking-options-plugins.html Thanks, Edgar *From: *Mohammad Banikazemi *m...@us.ibm.com* m...@us.ibm.com * Date: *Monday, March 10, 2014 2:40 PM * To: *OpenStack List *openstack-dev@lists.openstack.org*openstack-dev@lists.openstack.org * Cc: *Edgar Magana *emag...@plumgrid.com* emag...@plumgrid.com * Subject: *Re: [openstack-dev] [Neutron] Docs for new plugins Would like to know what to do for adding documentation for a new plugin. Can someone point me to the right place/process please. Thanks, Mohammad ___ OpenStack-dev mailing list *OpenStack-dev@lists.openstack.org* OpenStack-dev@lists.openstack.org *http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev*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 inline: graycol.gif___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [Neutron] Docs for new plugins
Thanks for the input Anne! Kyle, Please file the proper bugs in the manual projects to be able to track the progress of this topic. Thanks, Edgar From: Anne Gentle a...@openstack.org Date: Wednesday, March 19, 2014 4:54 AM To: Edgar Magana emag...@plumgrid.com Cc: OpenStack List openstack-dev@lists.openstack.org Subject: Re: [openstack-dev] [Neutron] Docs for new plugins On Wed, Mar 19, 2014 at 12:45 AM, Edgar Magana emag...@plumgrid.com wrote: Including Anne in this thread. Anne, Can your provide your input here? Thanks, Edgar From: Mohammad Banikazemi m...@us.ibm.com Reply-To: OpenStack List openstack-dev@lists.openstack.org Date: Monday, March 17, 2014 8:02 AM To: OpenStack List openstack-dev@lists.openstack.org Subject: Re: [openstack-dev] [Neutron] Docs for new plugins I think the docs get updated for each release, so probably the newly added stuff (after I3) will be picked up by the RC1 release date. (cc'ing Tom Fifield for a definitive answer.) By the way I do see the odl config table in the openstack-manuals source tree: https://github.com/openstack/openstack-manuals/blob/master/doc/common/tables/n eutron-ml2_odl.xml and that is being referenced here: https://github.com/openstack/openstack-manuals/blob/master/doc/config-referenc e/networking/section_networking-plugins-ml2.xml Best, Mohammad Kyle Mestery ---03/17/2014 09:40:51 AM---Edgar: I don't see the configuration options for the OpenDaylight ML2 Hi Kyle, there is still a manual step by a docs person to run the scripts and create a patch. Does Gauvain's patch contain the OpenDaylight config options? https://review.openstack.org/#/c/81013/ https://review.openstack.org/#/c/81013/ I also want to note that just because there is reference information doesn't mean the docs are complete -- are there concepts and tasks still to be written so that users know how to use this ML2 plug-in and that it's available? Add those to the Cloud Administration Guide please. Thanks, Anne From: Kyle Mestery mest...@noironetworks.com To: OpenStack Development Mailing List (not for usage questions) openstack-dev@lists.openstack.org, Date: 03/17/2014 09:40 AM Subject: Re: [openstack-dev] [Neutron] Docs for new plugins Edgar: I don't see the configuration options for the OpenDaylight ML2 MechanismDriver added here yet, even though the code was checked in well over a week ago. How long does it take to autogenerate this page from the code? Thanks! Kyle On Wed, Mar 12, 2014 at 5:10 PM, Edgar Magana emag...@plumgrid.com mailto:emag...@plumgrid.com wrote: You should be able to add your plugin here: http://docs.openstack.org/havana/config-reference/content/networking-options- plugins.html http://docs.openstack.org/havana/config-reference/content/networking-options -plugins.html Thanks, Edgar From: Mohammad Banikazemi m...@us.ibm.com mailto:m...@us.ibm.com Date: Monday, March 10, 2014 2:40 PM To: OpenStack List openstack-dev@lists.openstack.org mailto:openstack-dev@lists.openstack.org Cc: Edgar Magana emag...@plumgrid.com mailto:emag...@plumgrid.com Subject: Re: [openstack-dev] [Neutron] Docs for new plugins Would like to know what to do for adding documentation for a new plugin. Can someone point me to the right place/process please. Thanks, Mohammad ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org mailto:OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev 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.orghttp://lists.openstack.org/cgi-bin/mailman/li stinfo/openstack-dev inline: graycol.gif___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [Neutron] Docs for new plugins
I opened this bug Edgar: https://bugs.launchpad.net/openstack-manuals/+bug/1294726 On Wed, Mar 19, 2014 at 10:17 AM, Edgar Magana emag...@plumgrid.com wrote: Thanks for the input Anne! Kyle, Please file the proper bugs in the manual projects to be able to track the progress of this topic. Thanks, Edgar From: Anne Gentle a...@openstack.org Date: Wednesday, March 19, 2014 4:54 AM To: Edgar Magana emag...@plumgrid.com Cc: OpenStack List openstack-dev@lists.openstack.org Subject: Re: [openstack-dev] [Neutron] Docs for new plugins On Wed, Mar 19, 2014 at 12:45 AM, Edgar Magana emag...@plumgrid.comwrote: Including Anne in this thread. Anne, Can your provide your input here? Thanks, Edgar From: Mohammad Banikazemi m...@us.ibm.com Reply-To: OpenStack List openstack-dev@lists.openstack.org Date: Monday, March 17, 2014 8:02 AM To: OpenStack List openstack-dev@lists.openstack.org Subject: Re: [openstack-dev] [Neutron] Docs for new plugins I think the docs get updated for each release, so probably the newly added stuff (after I3) will be picked up by the RC1 release date. (cc'ing Tom Fifield for a definitive answer.) By the way I do see the odl config table in the openstack-manuals source tree: https://github.com/openstack/openstack-manuals/blob/master/doc/common/tables/neutron-ml2_odl.xml and that is being referenced here: https://github.com/openstack/openstack-manuals/blob/master/doc/config-reference/networking/section_networking-plugins-ml2.xml Best, Mohammad [image: Inactive hide details for Kyle Mestery ---03/17/2014 09:40:51 AM---Edgar: I don't see the configuration options for the OpenDay]Kyle Mestery ---03/17/2014 09:40:51 AM---Edgar: I don't see the configuration options for the OpenDaylight ML2 Hi Kyle, there is still a manual step by a docs person to run the scripts and create a patch. Does Gauvain's patch contain the OpenDaylight config options? https://review.openstack.org/#/c/81013/ I also want to note that just because there is reference information doesn't mean the docs are complete -- are there concepts and tasks still to be written so that users know how to use this ML2 plug-in and that it's available? Add those to the Cloud Administration Guide please. Thanks, Anne From: Kyle Mestery mest...@noironetworks.com To: OpenStack Development Mailing List (not for usage questions) openstack-dev@lists.openstack.org, Date: 03/17/2014 09:40 AM Subject: Re: [openstack-dev] [Neutron] Docs for new plugins -- Edgar: I don't see the configuration options for the OpenDaylight ML2 MechanismDriver added here yet, even though the code was checked in well over a week ago. How long does it take to autogenerate this page from the code? Thanks! Kyle On Wed, Mar 12, 2014 at 5:10 PM, Edgar Magana *emag...@plumgrid.com*emag...@plumgrid.com wrote: You should be able to add your plugin here: *http://docs.openstack.org/havana/config-reference/content/networking-options-plugins.html*http://docs.openstack.org/havana/config-reference/content/networking-options-plugins.html Thanks, Edgar *From: *Mohammad Banikazemi *m...@us.ibm.com* m...@us.ibm.com * Date: *Monday, March 10, 2014 2:40 PM * To: *OpenStack List *openstack-dev@lists.openstack.org*openstack-dev@lists.openstack.org * Cc: *Edgar Magana *emag...@plumgrid.com* emag...@plumgrid.com * Subject: *Re: [openstack-dev] [Neutron] Docs for new plugins Would like to know what to do for adding documentation for a new plugin. Can someone point me to the right place/process please. Thanks, Mohammad ___ OpenStack-dev mailing list *OpenStack-dev@lists.openstack.org* OpenStack-dev@lists.openstack.org *http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev*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 ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev inline: graycol.gif___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [Neutron] Docs for new plugins
Including Anne in this thread. Anne, Can your provide your input here? Thanks, Edgar From: Mohammad Banikazemi m...@us.ibm.com Reply-To: OpenStack List openstack-dev@lists.openstack.org Date: Monday, March 17, 2014 8:02 AM To: OpenStack List openstack-dev@lists.openstack.org Subject: Re: [openstack-dev] [Neutron] Docs for new plugins I think the docs get updated for each release, so probably the newly added stuff (after I3) will be picked up by the RC1 release date. (cc'ing Tom Fifield for a definitive answer.) By the way I do see the odl config table in the openstack-manuals source tree: https://github.com/openstack/openstack-manuals/blob/master/doc/common/tables /neutron-ml2_odl.xml and that is being referenced here: https://github.com/openstack/openstack-manuals/blob/master/doc/config-refere nce/networking/section_networking-plugins-ml2.xml Best, Mohammad Kyle Mestery ---03/17/2014 09:40:51 AM---Edgar: I don't see the configuration options for the OpenDaylight ML2 From: Kyle Mestery mest...@noironetworks.com To: OpenStack Development Mailing List (not for usage questions) openstack-dev@lists.openstack.org, Date: 03/17/2014 09:40 AM Subject: Re: [openstack-dev] [Neutron] Docs for new plugins Edgar: I don't see the configuration options for the OpenDaylight ML2 MechanismDriver added here yet, even though the code was checked in well over a week ago. How long does it take to autogenerate this page from the code? Thanks! Kyle On Wed, Mar 12, 2014 at 5:10 PM, Edgar Magana emag...@plumgrid.com mailto:emag...@plumgrid.com wrote: You should be able to add your plugin here: http://docs.openstack.org/havana/config-reference/content/networking-options-p lugins.html http://docs.openstack.org/havana/config-reference/content/networking-options- plugins.html Thanks, Edgar From: Mohammad Banikazemi m...@us.ibm.com mailto:m...@us.ibm.com Date: Monday, March 10, 2014 2:40 PM To: OpenStack List openstack-dev@lists.openstack.org mailto:openstack-dev@lists.openstack.org Cc: Edgar Magana emag...@plumgrid.com mailto:emag...@plumgrid.com Subject: Re: [openstack-dev] [Neutron] Docs for new plugins Would like to know what to do for adding documentation for a new plugin. Can someone point me to the right place/process please. Thanks, Mohammad ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org mailto:OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev 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 inline: graycol.gif___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [Neutron] Docs for new plugins
Edgar: I don't see the configuration options for the OpenDaylight ML2 MechanismDriver added here yet, even though the code was checked in well over a week ago. How long does it take to autogenerate this page from the code? Thanks! Kyle On Wed, Mar 12, 2014 at 5:10 PM, Edgar Magana emag...@plumgrid.com wrote: You should be able to add your plugin here: http://docs.openstack.org/havana/config-reference/content/networking-options-plugins.html Thanks, Edgar From: Mohammad Banikazemi m...@us.ibm.com Date: Monday, March 10, 2014 2:40 PM To: OpenStack List openstack-dev@lists.openstack.org Cc: Edgar Magana emag...@plumgrid.com Subject: Re: [openstack-dev] [Neutron] Docs for new plugins Would like to know what to do for adding documentation for a new plugin. Can someone point me to the right place/process please. Thanks, Mohammad ___ 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] [Neutron] Docs for new plugins
I think the docs get updated for each release, so probably the newly added stuff (after I3) will be picked up by the RC1 release date. (cc'ing Tom Fifield for a definitive answer.) By the way I do see the odl config table in the openstack-manuals source tree: https://github.com/openstack/openstack-manuals/blob/master/doc/common/tables/neutron-ml2_odl.xml and that is being referenced here: https://github.com/openstack/openstack-manuals/blob/master/doc/config-reference/networking/section_networking-plugins-ml2.xml Best, Mohammad From: Kyle Mestery mest...@noironetworks.com To: OpenStack Development Mailing List (not for usage questions) openstack-dev@lists.openstack.org, Date: 03/17/2014 09:40 AM Subject:Re: [openstack-dev] [Neutron] Docs for new plugins Edgar: I don't see the configuration options for the OpenDaylight ML2 MechanismDriver added here yet, even though the code was checked in well over a week ago. How long does it take to autogenerate this page from the code? Thanks! Kyle On Wed, Mar 12, 2014 at 5:10 PM, Edgar Magana emag...@plumgrid.com wrote: You should be able to add your plugin here: http://docs.openstack.org/havana/config-reference/content/networking-options-plugins.html Thanks, Edgar From: Mohammad Banikazemi m...@us.ibm.com Date: Monday, March 10, 2014 2:40 PM To: OpenStack List openstack-dev@lists.openstack.org Cc: Edgar Magana emag...@plumgrid.com Subject: Re: [openstack-dev] [Neutron] Docs for new plugins Would like to know what to do for adding documentation for a new plugin. Can someone point me to the right place/process please. Thanks, Mohammad ___ 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 inline: graycol.gif___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [Neutron] Docs for new plugins
Hi There, Basically, we just wanted to be sure that the pre-populated information is accurate and if there is nothing else to add you can close the bug. Thanks, Edgar From: Mohammad Banikazemi m...@us.ibm.com Date: Wednesday, March 12, 2014 8:53 PM To: OpenStack List openstack-dev@lists.openstack.org Cc: Edgar Magana emag...@plumgrid.com, OpenStack List openstack-dev@lists.openstack.org Subject: Re: [openstack-dev] [Neutron] Docs for new plugins Tom Fifield t...@openstack.org wrote on 03/12/2014 10:51:54 PM: From: Tom Fifield t...@openstack.org To: OpenStack Development Mailing List (not for usage questions) openstack-dev@lists.openstack.org, Edgar Magana emag...@plumgrid.com, Date: 03/12/2014 10:59 PM Subject: Re: [openstack-dev] [Neutron] Docs for new plugins On 13/03/14 13:43, Mohammad Banikazemi wrote: Thanks for your response. It looks like the page you are referring to gets populated automatically and I see a link already added to it for the new plugin. I also see a file corresponding to the new plugin having been created and populated with the plugin config options in the latest openstack-manuals cloned from github. After talking to the docs people on #openstack-docs, now I know that these files get created automatically and periodically. Any changes to the docs should come through changes to the config file in the code which will be automatically picked up at some point when the docs scripts get executed. Just to clarify one point - the text comes from the code, in the oslo option registration's helptext, not from the configuration files in etc. Thanks for clarifying this point and for the initial information as well. Yes, by config file in the code I was referring to the config.py file in our plugin (and a few other Neutron plugins I have seen) where the plugin options and corresponding helptexts get registered by using register_opts() from oslo. It looks like there is nothing to be done in this front for adding the docs for the new plugin. If that seems reasonable, I will close the bug I had opened for the the docs for our plugin. Thanks, -Mohammad Inactive hide details for Edgar Magana ---03/12/2014 06:10:31 PM---You should be able to add your plugin here: http://docs.openEdgar Magana ---03/12/2014 06:10:31 PM---You should be able to add your plugin here: http://docs.openstack.org/havana/config-reference/conten From: Edgar Magana emag...@plumgrid.com To: Mohammad Banikazemi/Watson/IBM@IBMUS, OpenStack Development Mailing List (not for usage questions) openstack-dev@lists.openstack.org, Date: 03/12/2014 06:10 PM Subject: Re: [openstack-dev] [Neutron] Docs for new plugins You should be able to add your plugin here: _http://docs.openstack.org/havana/config-reference/content/ networking-options-plugins.html_ Thanks, Edgar *From: *Mohammad Banikazemi _...@us.ibm.com_ mailto:m...@us.ibm.com* Date: *Monday, March 10, 2014 2:40 PM* To: *OpenStack List _openstack-dev@lists.openstack.org_ mailto:openstack-dev@lists.openstack.org* Cc: *Edgar Magana _emagana@plumgrid.com_ mailto:emag...@plumgrid.com* Subject: *Re: [openstack-dev] [Neutron] Docs for new plugins Would like to know what to do for adding documentation for a new plugin. Can someone point me to the right place/process please. Thanks, Mohammad ___ 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] [Neutron] Docs for new plugins
You should be able to add your plugin here: http://docs.openstack.org/havana/config-reference/content/networking-options -plugins.html Thanks, Edgar From: Mohammad Banikazemi m...@us.ibm.com Date: Monday, March 10, 2014 2:40 PM To: OpenStack List openstack-dev@lists.openstack.org Cc: Edgar Magana emag...@plumgrid.com Subject: Re: [openstack-dev] [Neutron] Docs for new plugins Would like to know what to do for adding documentation for a new plugin. Can someone point me to the right place/process please. Thanks, Mohammad ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [Neutron] Docs for new plugins
Thanks for your response. It looks like the page you are referring to gets populated automatically and I see a link already added to it for the new plugin. I also see a file corresponding to the new plugin having been created and populated with the plugin config options in the latest openstack-manuals cloned from github. After talking to the docs people on #openstack-docs, now I know that these files get created automatically and periodically. Any changes to the docs should come through changes to the config file in the code which will be automatically picked up at some point when the docs scripts get executed. It looks like there is nothing to be done in this front for adding the docs for the new plugin. If that seems reasonable, I will close the bug I had opened for the the docs for our plugin. Thanks, -Mohammad From: Edgar Magana emag...@plumgrid.com To: Mohammad Banikazemi/Watson/IBM@IBMUS, OpenStack Development Mailing List (not for usage questions) openstack-dev@lists.openstack.org, Date: 03/12/2014 06:10 PM Subject:Re: [openstack-dev] [Neutron] Docs for new plugins You should be able to add your plugin here: http://docs.openstack.org/havana/config-reference/content/networking-options-plugins.html Thanks, Edgar From: Mohammad Banikazemi m...@us.ibm.com Date: Monday, March 10, 2014 2:40 PM To: OpenStack List openstack-dev@lists.openstack.org Cc: Edgar Magana emag...@plumgrid.com Subject: Re: [openstack-dev] [Neutron] Docs for new plugins Would like to know what to do for adding documentation for a new plugin. Can someone point me to the right place/process please. Thanks, Mohammad inline: graycol.gif___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [Neutron] Docs for new plugins
On 13/03/14 13:43, Mohammad Banikazemi wrote: Thanks for your response. It looks like the page you are referring to gets populated automatically and I see a link already added to it for the new plugin. I also see a file corresponding to the new plugin having been created and populated with the plugin config options in the latest openstack-manuals cloned from github. After talking to the docs people on #openstack-docs, now I know that these files get created automatically and periodically. Any changes to the docs should come through changes to the config file in the code which will be automatically picked up at some point when the docs scripts get executed. Just to clarify one point - the text comes from the code, in the oslo option registration's helptext, not from the configuration files in etc. It looks like there is nothing to be done in this front for adding the docs for the new plugin. If that seems reasonable, I will close the bug I had opened for the the docs for our plugin. Thanks, -Mohammad Inactive hide details for Edgar Magana ---03/12/2014 06:10:31 PM---You should be able to add your plugin here: http://docs.openEdgar Magana ---03/12/2014 06:10:31 PM---You should be able to add your plugin here: http://docs.openstack.org/havana/config-reference/conten From: Edgar Magana emag...@plumgrid.com To: Mohammad Banikazemi/Watson/IBM@IBMUS, OpenStack Development Mailing List (not for usage questions) openstack-dev@lists.openstack.org, Date: 03/12/2014 06:10 PM Subject: Re: [openstack-dev] [Neutron] Docs for new plugins You should be able to add your plugin here: _http://docs.openstack.org/havana/config-reference/content/networking-options-plugins.html_ Thanks, Edgar *From: *Mohammad Banikazemi _...@us.ibm.com_ mailto:m...@us.ibm.com* Date: *Monday, March 10, 2014 2:40 PM* To: *OpenStack List _openstack-dev@lists.openstack.org_ mailto:openstack-dev@lists.openstack.org* Cc: *Edgar Magana _emagana@plumgrid.com_ mailto:emag...@plumgrid.com* Subject: *Re: [openstack-dev] [Neutron] Docs for new plugins Would like to know what to do for adding documentation for a new plugin. Can someone point me to the right place/process please. Thanks, Mohammad ___ 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] [Neutron] Docs for new plugins
Tom Fifield t...@openstack.org wrote on 03/12/2014 10:51:54 PM: From: Tom Fifield t...@openstack.org To: OpenStack Development Mailing List (not for usage questions) openstack-dev@lists.openstack.org, Edgar Magana emag...@plumgrid.com, Date: 03/12/2014 10:59 PM Subject: Re: [openstack-dev] [Neutron] Docs for new plugins On 13/03/14 13:43, Mohammad Banikazemi wrote: Thanks for your response. It looks like the page you are referring to gets populated automatically and I see a link already added to it for the new plugin. I also see a file corresponding to the new plugin having been created and populated with the plugin config options in the latest openstack-manuals cloned from github. After talking to the docs people on #openstack-docs, now I know that these files get created automatically and periodically. Any changes to the docs should come through changes to the config file in the code which will be automatically picked up at some point when the docs scripts get executed. Just to clarify one point - the text comes from the code, in the oslo option registration's helptext, not from the configuration files in etc. Thanks for clarifying this point and for the initial information as well. Yes, by config file in the code I was referring to the config.py file in our plugin (and a few other Neutron plugins I have seen) where the plugin options and corresponding helptexts get registered by using register_opts() from oslo. It looks like there is nothing to be done in this front for adding the docs for the new plugin. If that seems reasonable, I will close the bug I had opened for the the docs for our plugin. Thanks, -Mohammad Inactive hide details for Edgar Magana ---03/12/2014 06:10:31 PM---You should be able to add your plugin here: http://docs.openEdgar Magana ---03/12/2014 06:10:31 PM---You should be able to add your plugin here: http://docs.openstack.org/havana/config-reference/conten From: Edgar Magana emag...@plumgrid.com To: Mohammad Banikazemi/Watson/IBM@IBMUS, OpenStack Development Mailing List (not for usage questions) openstack-dev@lists.openstack.org, Date: 03/12/2014 06:10 PM Subject: Re: [openstack-dev] [Neutron] Docs for new plugins You should be able to add your plugin here: _http://docs.openstack.org/havana/config-reference/content/ networking-options-plugins.html_ Thanks, Edgar *From: *Mohammad Banikazemi _...@us.ibm.com_ mailto:m...@us.ibm.com* Date: *Monday, March 10, 2014 2:40 PM* To: *OpenStack List _openstack-dev@lists.openstack.org_ mailto:openstack-dev@lists.openstack.org* Cc: *Edgar Magana _emagana@plumgrid.com_ mailto:emag...@plumgrid.com* Subject: *Re: [openstack-dev] [Neutron] Docs for new plugins Would like to know what to do for adding documentation for a new plugin. Can someone point me to the right place/process please. Thanks, Mohammad ___ 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] [Neutron] Docs for new plugins
Would like to know what to do for adding documentation for a new plugin. Can someone point me to the right place/process please. Thanks, Mohammad___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
