<div dir="ltr">Hi,<div><br></div><div>If the plan is to move ALL existing vendor specific plugins/drivers out-of-tree, then having a place-holder within the OpenStack domain would suffice, where the vendors can list their plugins/drivers along with their documentation as how to install and use etc. </div><div><br></div><div>The main Openstack Neutron documentation page can explain the plugin framework (ml2 type drivers, mechanism drivers, serviec plugin and so on) and its purpose/usage etc, then provide a link to refer the currently supported vendor specific plugins/drivers for more details.  That way the documentation will be accurate to what is "in-tree" and limit the documentation of external plugins/drivers to have just a reference link. So its now vendor's responsibility to keep their  driver's up-to-date and their documentation accurate. The OpenStack dev and docs team dont have to worry about gating/publishing/maintaining the vendor specific plugins/drivers.  </div><div><br></div><div>The built-in drivers such as LinuxBridge or OpenVSwitch etc can continue to be "in-tree" and their documentation will be part of main Neutron's docs. So the Neutron is guaranteed to work with built-in plugins/drivers as per the documentation and the user is informed to refer the "external vendor plug-in page" for additional/specific plugins/drivers. </div><div><br></div><div><br></div><div>Thanks,</div><div>Vad</div><div>--</div><div><br></div></div><div class="gmail_extra"><br><div class="gmail_quote">On Fri, Oct 10, 2014 at 8:10 PM, Anne Gentle <span dir="ltr"><<a href="mailto:anne@openstack.org" target="_blank">anne@openstack.org</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote"><span class="">On Fri, Oct 10, 2014 at 7:36 PM, Kevin Benton <span dir="ltr"><<a href="mailto:blak111@gmail.com" target="_blank">blak111@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div dir="ltr">I think you will probably have to wait until after the summit so we can see the direction that will be taken with the rest of the in-tree drivers/plugins. It seems like we are moving towards removing all of them so we would definitely need a solution to documenting out-of-tree drivers as you suggested. <div><br></div><div>However, I think the minimum requirements for having a driver being documented should be third-party testing of Neutron patches. Otherwise the docs will become littered with a bunch of links to drivers/plugins with no indication of what actually works, which ultimately makes Neutron look bad.</div></div></blockquote><div><br></div></span><div>This is my line of thinking as well, expanded to "ultimately makes OpenStack docs look bad" -- a perception I want to avoid. </div><div><br></div><div>Keep the viewpoints coming. We have a crucial balancing act ahead: users need to trust docs and trust the drivers. Ultimately the responsibility for the docs is in the hands of the driver contributors so it seems those should be on a domain name where drivers control publishing and OpenStack docs are not a gatekeeper, quality checker, reviewer, or publisher. </div><div><br></div><div>We have documented the status of hypervisor drivers on an OpenStack wiki page. [1] To me, that type of list could be maintained on the wiki page better than in the docs themselves. Thoughts? Feelings? More discussion, please. And thank you for the responses so far. </div><div>Anne</div><div><br></div><div>[1] <a href="https://wiki.openstack.org/wiki/HypervisorSupportMatrix" target="_blank">https://wiki.openstack.org/wiki/HypervisorSupportMatrix</a></div><div><div class="h5"><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div class="gmail_extra"><div><div><br><div class="gmail_quote">On Fri, Oct 10, 2014 at 1:28 PM, Vadivel Poonathan <span dir="ltr"><<a href="mailto:vadivel.openstack@gmail.com" target="_blank">vadivel.openstack@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div dir="ltr">Hi Anne,<div><br></div><div>Thanks for your immediate response!...</div><div><br></div><div>Just to clarify... I have developed and maintaining a Neutron plug-in (ML2 mechanism_driver) since Grizzly and now it is up-to-date with Icehouse. But it was never listed nor part of the main Openstack releases. Now i would like to have my plugin mentioned as "supported plugin/mechanism_driver for so and so vendor equipments" in the <a href="http://docs.openstack.org" target="_blank">docs.openstack.org</a>, but without having the actual plugin code to be posted in the main Openstack GIT repository. </div><div><br></div><div>Reason is that I dont have plan/bandwidth to go thru the entire process of new plugin blue-print/development/review/testing etc as required by the Openstack development community. Bcos this is already developed, tested and released to some customers directly. Now I just want to get it to the official Openstack documentation, so that more people can get this and use. </div><div><br></div><div>The plugin package is made available to public from Ubuntu repository along with necessary documentation. So people can directly get it from Ubuntu repository and use it. All i need is to get listed in the <a href="http://docs.openstack.org" target="_blank">docs.openstack.org</a> so that people knows that it exists and can be used with any Openstack.</div><div><br></div><div>Pls. confrim whether this is something possible?...</div><div><br></div><div>Thanks again!..</div><div><br></div><div>Vad</div><div>--</div></div><div><div><div class="gmail_extra"><br><div class="gmail_quote">On Fri, Oct 10, 2014 at 12:18 PM, Anne Gentle <span dir="ltr"><<a href="mailto:anne@openstack.org" target="_blank">anne@openstack.org</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote"><span>On Fri, Oct 10, 2014 at 2:11 PM, Vadivel Poonathan <span dir="ltr"><<a href="mailto:vadivel.openstack@gmail.com" target="_blank">vadivel.openstack@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div dir="ltr"><p style="margin:0px 0px 14px;padding:0px 5px 5px 0px;border:none;font-size:14px;line-height:1.4;font-family:'Helvetica Neue',Arial,Helvetica,sans-serif;color:rgb(75,75,75)">Hi,</p><p style="margin:0px 0px 14px;padding:0px 5px 5px 0px;border:none;font-size:14px;line-height:1.4;font-family:'Helvetica Neue',Arial,Helvetica,sans-serif;color:rgb(75,75,75)">How to include a new vendor plug-in (aka mechanism_driver in ML2 framework) into the Openstack documentation?.. In other words, is it possible to include a new plug-in in the Openstack documentation page without having the actual plug-in code as part of the Openstack neutron repository?... The actual plug-in is posted and available for the public to download as Ubuntu package. But i need to mention somewhere in the Openstack documentation that this new plugin is available for the public to use along with its documentation.</p></div></blockquote><div><br></div></span><div>We definitely want you to include pointers to vendor documentation in the OpenStack docs, but I'd prefer make sure they're gate tested before they get listed on <a href="http://docs.openstack.org" target="_blank">docs.openstack.org</a>. Drivers change enough release-to-release that it's difficult to keep up maintenance.</div><div><br></div><div>Lately I've been talking to driver contributors (hypervisor, storage, networking) about the out-of-tree changes possible. I'd like to encourage even out-of-tree drivers to get listed, but to store their main documents outside of <a href="http://docs.openstack.org" target="_blank">docs.openstack.org</a>, if they are gate-tested.<br></div><div><br></div><div>Anyone have other ideas here?</div><div><br></div><div>Looping in the OpenStack-docs mailing list also. <br></div><div>Anne</div><div><br></div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><span><div dir="ltr"><p style="margin:0px 0px 14px;padding:0px 5px 5px 0px;border:none;font-size:14px;line-height:1.4;font-family:'Helvetica Neue',Arial,Helvetica,sans-serif;color:rgb(75,75,75)">Pls. provide some insights into whether it is possible?.. and any further info on this?..</p><p style="margin:0px 0px 14px;padding:0px 5px 5px 0px;border:none;font-size:14px;line-height:1.4;font-family:'Helvetica Neue',Arial,Helvetica,sans-serif;color:rgb(75,75,75)">Thanks,</p><p style="margin:0px 0px 14px;padding:0px 5px 5px 0px;border:none;font-size:14px;line-height:1.4;font-family:'Helvetica Neue',Arial,Helvetica,sans-serif;color:rgb(75,75,75)">Vad</p><p style="margin:0px 0px 14px;padding:0px 5px 5px 0px;border:none;font-size:14px;line-height:1.4;font-family:'Helvetica Neue',Arial,Helvetica,sans-serif;color:rgb(75,75,75)">--</p></div>
<br></span>_______________________________________________<br>
OpenStack-dev mailing list<br>
<a href="mailto:OpenStack-dev@lists.openstack.org" target="_blank">OpenStack-dev@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><br>
<br></blockquote></div><br></div></div>
<br>_______________________________________________<br>
OpenStack-dev mailing list<br>
<a href="mailto:OpenStack-dev@lists.openstack.org" target="_blank">OpenStack-dev@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><br>
<br></blockquote></div><br></div>
</div></div><br>_______________________________________________<br>
OpenStack-dev mailing list<br>
<a href="mailto:OpenStack-dev@lists.openstack.org" target="_blank">OpenStack-dev@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><br>
<br></blockquote></div><br><br clear="all"><div><br></div></div></div><span><font color="#888888">-- <br><div>Kevin Benton</div>
</font></span></div>
<br>_______________________________________________<br>
OpenStack-dev mailing list<br>
<a href="mailto:OpenStack-dev@lists.openstack.org" target="_blank">OpenStack-dev@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><br>
<br></blockquote></div></div></div><br></div></div>
<br>_______________________________________________<br>
OpenStack-dev mailing list<br>
<a href="mailto:OpenStack-dev@lists.openstack.org">OpenStack-dev@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><br>
<br></blockquote></div><br></div>