On Apr 9, 2015, at 2:24 AM, Phillip Kent <phillip.k...@xmlsoup.com> wrote:
> Hi Sebastian, > > I would add to the documentation section: > > - Review and improve the API Reference documentation > > (I tried to login to wiki and edit, but did not seem to have edit privileges > for that page) > I just granted you access, so edit boldly :) > The API reference is of course different in character from the other docs > because it is generated out of embedded doc strings in the source code. The > issues that I have found are: parameters being required but are not marked as > required (and probably there are cases of vice versa); inaccurate command > description text; have a better format for marking parameters that are > conditionally required; general problem of description text being too brief > to properly explain the action of the command and how to use the parameters > (in fact, most of the descriptions would benefit from expansion). > > Another documentation issue perhaps is maintaining a coherent documentation > set across multiple ACS versions; something analogous to the backporting > efforts on the source code. > > - Phillip > > (BTW I don't feel I know enough of the CloudStack internals to lead any of > the doc tasks but I am keen to be involved as an assistant writer, editor, > reviewer or otherwise.) > > ---------- Forwarded message ---------- > From: Sebastien Goasguen <run...@gmail.com> > To: users@cloudstack.apache.org > Cc: > Date: Mon, 6 Apr 2015 23:39:15 +0200 > Subject: 2015 plan > Hi Folks, > > Based on feedback I received on my thoughts as new VP, I created a wiki page > with a summary of them as well as some updates. > > I encourage everyone to chime in on that page. Put your name on some ideas > that you are or intend to be working on, > > https://cwiki.apache.org/confluence/display/CLOUDSTACK/2015+Plan > > This can become our plan, just edit the page, let’s try to keep it organized > and up to date. > > Cheers, > > -Sebastien
