Open Stack

Tom Fifield <tom at openstack.org> wrote on 03/12/2014 10:51:54 PM:

> From: Tom Fifield <tom at openstack.org>
> To: "OpenStack Development Mailing List (not for usage questions)"
> <openstack-dev at lists.openstack.org>, Edgar Magana <emagana at 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 <emagana at plumgrid.com>
> > To: Mohammad Banikazemi/Watson/IBM at IBMUS, "OpenStack Development
Mailing
> > List (not for usage questions)" <openstack-dev at 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 <_mb at us.ibm.com_ <mailto:mb at us.ibm.com>>*
> > Date: *Monday, March 10, 2014 2:40 PM*
> > To: *OpenStack List <_openstack-dev at lists.openstack.org_
> > <mailto:openstack-dev at lists.openstack.org>>*
> > Cc: *Edgar Magana <_emagana at plumgrid.com_
<mailto:emagana at 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 at lists.openstack.org
> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
> >
>
>
> _______________________________________________
> OpenStack-dev mailing list
> 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/20140312/c20fb619/attachment.html>