[openstack-dev] [Fuel] Plugins for Fuel: repo, doc, spec - where?
ipovolotskaya at mirantis.com
Fri Jan 23 10:06:53 UTC 2015
Hi Fuelers and Mike,
I'd like to provide some ideas/comments for the issues Mike has put into
Yesterday we had a nice discussion for plugins SDK.
According to this discussion, we should create an internal document for
plugins certification ASAP (I mean, steps to perform on the developers'
side and assignees for the particular tasks).
So, we could also describe there (just what you've mentioned):
- repo issue: we should definitely mention that
stackforge/fuel-plugin-<name> is strongly recommended for usage (we have
some common information in Fuel Plug-in Guide, but an internal document
should focus on that)
- docs for plugins: I'm already working on .pdf templates for both
Plugin Guide (how to install/configure a plugin) and Test Plan/Report
(we'll just move to the simplest format ever, but note that this is mostly
related to certification workflow). Nevertheless, some repos already
contain README.md files with a brief description,
installation/configuration instructions. For example, see Borgan D plugin's
. There is no spec, but the concept seems clear on the whole.
- As to specification: developers should provide it in the Test Plan, so
it would be okay if they followed one of these two ways:1) took fuel-specs
template as the basis and simply made a link from their Test Plan/Report to
the spec 2) post this spec right in the Test Plan/Report.
- test in the repo: sure, this should be covered.
I believe, I'll mostly be working on this internal document, so feel free
to comment/correct me, if something seems wrong here.
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the OpenStack-dev