[openstack-dev] [Fuel] Plugins for Fuel: repo, doc, spec - where?

Evgeniy L eli at mirantis.com
Fri Jan 23 10:25:32 UTC 2015

Hi Mike,

All of the items look nice. I have a small comment regarding to the docs.
I don't think that we should force plugin developer to write the docs in
Sphinx compatible format, I vote for Github compatible docs format,
and in case if we want to show this information somewhere else,
we can use Github's engine [1] to convert the docs into html pages.


[1] https://github.com/github/markup/tree/master

On Fri, Jan 23, 2015 at 1:25 AM, Mike Scherbakov <mscherbakov at mirantis.com>

> Hi Fuelers,
> we've implemented pluggable architecture piece in 6.0, and got a number of
> plugins already. Overall development process for plugins is still not fully
> defined.
> We initially thought that having all the plugins in one repo on stackforge
> is Ok, we also put some docs into existing fuel-docs repo, and specs to
> fuel-specs.
> We might need a change here. Plugins are not tight to any particular
> release date, and they can also be separated each from other in terms of
> committers and core reviewers. Also, it seems to be pretty natural to keep
> all docs and design specs associated with particular plugin.
> With all said, following best dev practices, it is suggested to:
>    1. Have a separate stackforge repo per Fuel plugin in format
>    "fuel-plugin-<name>", with separate core-reviewers group which should have
>    plugin contributor initially
>    2. Have docs folder in the plugin, and ability to build docs out of it
>       - do we want Sphinx or simple Github docs format is Ok? So people
>       can just go to github/stackforge to see docs
>    3. Have specification in the plugin repo
>       - also, do we need Sphinx here?
>    4. Have plugins tests in the repo
> Ideas / suggestions / comments?
> Thanks,
> --
> Mike Scherbakov
> #mihgen
> __________________________________________________________________________
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
> 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/20150123/2e480239/attachment.html>

More information about the OpenStack-dev mailing list