There are many such issues. Can we chart down something concrete ? My suggestion is simple: Volunteer can pick up one feature each and fix all issues related to the API documentation: Description, build (can take help from infra), how-to info
Experts, please advise. -----Original Message----- From: Gaurav Aradhye [mailto:gaurav.arad...@clogeny.com] Sent: Thursday, January 30, 2014 5:00 PM To: dev@cloudstack.apache.org Subject: Re: API documentation I found following 3 APIs related to adding load balancer devices absent in the documentation. 1. addExternalLoadBalancer 2. addF5LoadBalancer 3. addNetscalerLoadBalancer Regards, Gaurav On Thu, Jan 30, 2014 at 4:09 PM, sebgoa <run...@gmail.com> wrote: > > On Jan 30, 2014, at 10:53 AM, Paul Angus <paul.an...@shapeblue.com> wrote: > > > Hey Radhika, > > > > Yes, I'm happy to do what I can (probably mainly harassing other > > people) > > > > CloudMonkey says that there are 431 API calls (in 4.3 RC1) I recon > > there > are 409 listed on > http://cloudstack.apache.org/docs/api/apidocs-4.2/TOC_Root_Admin.html > > > > We talked about this recently, the discrepancy seems to come from the > fact that the apidocs are built for the oss dist and that the missing > apis are from the nonredist build. > > -sebastien > > > I'll try to find which ones are missing. > > > > I think in terms of the API documentation page, the first thing to > > do is > put this headings in alphabetical order! > > > > Regards, > > > > Paul Angus > > Cloud Architect > > S: +44 20 3603 0540 | M: +447711418784 | T: @CloudyAngus > > paul.an...@shapeblue.com > > > > -----Original Message----- > > From: Radhika Puthiyetath [mailto:radhika.puthiyet...@citrix.com] > > Sent: 30 January 2014 07:48 > > To: dev@cloudstack.apache.org > > Subject: RE: API documentation > > > > Hi Paul, > > > > Yes, API documentation requires a serious revisit. I had initiated a > discussion months back, and invited volunteers. > > > > A wiki page is created at > https://cwiki.apache.org/confluence/display/CLOUDSTACK/Documentation+S > print+for+Enhancing+API+Documentation > > , but nothing beyond that. > > > > If you are interested to volunteer, let's begin. > > > > -Radhika > > > > From: Paul Angus [mailto:paul.an...@shapeblue.com] > > Sent: Thursday, January 30, 2014 12:43 PM > > To: dev@cloudstack.apache.org > > Subject: API documentation > > > > DEVs, > > > > New features are generally cool, but given that the 'engine' of > CloudStack is the API it seems ridiculous that as a minimum the API > documentation isn't kept up to date. > > > > The specific example that I'm thinking of is > > > > addvmwaredc > > > > Only by using the UI and following the API calls sent could I find > > that > it existed, and then tracked it down in the design documents in the wiki. > > > > I've filed a bug for this one ( > https://issues.apache.org/jira/browse/CLOUDSTACK-5984) > > > > But please can everyone make sure we can all use the features you > > create > by documenting them. > > > > Regards > > > > Paul Angus > > Senior Consultant / Cloud Architect > > > > [cid:image002.png@01CE1071.C6CC9C10] > > > > S: +44 20 3603 0540<tel:+442036030540> | M: > +4<tel:+447968161581>47711418784 | T: @CloudyAngus > paul.an...@shapeblue.com<mailto:paul.an...@shapeblue.com> | > www.shapeblue.com<http://www.shapeblue.com/> | Twitter:@shapeblue< > https://twitter.com/> > > ShapeBlue Ltd, 53 Chandos Place, Covent Garden, London, WC2N 4HS > > > > Need Enterprise Grade Support for Apache CloudStack? > > Our CloudStack Infrastructure Support< > http://shapeblue.com/cloudstack-infrastructure-support/> offers the > best > 24/7 SLA for CloudStack Environments. > > > > Apache CloudStack Bootcamp training courses > > > > **NEW!** CloudStack 4.2.1 training< > http://shapeblue.com/cloudstack-training/> > > 18th-19th February 2014, Brazil. Classroom< > http://shapeblue.com/cloudstack-training/> > > 17th-23rd March 2014, Region A. Instructor led, On-line< > http://shapeblue.com/cloudstack-training/> > > 24th-28th March 2014, Region B. Instructor led, On-line< > http://shapeblue.com/cloudstack-training/> > > 16th-20th June 2014, Region A. Instructor led, On-line< > http://shapeblue.com/cloudstack-training/> > > 23rd-27th June 2014, Region B. Instructor led, On-line< > http://shapeblue.com/cloudstack-training/> > > > > This email and any attachments to it may be confidential and are > intended solely for the use of the individual to whom it is addressed. > Any views or opinions expressed are solely those of the author and do > not necessarily represent those of Shape Blue Ltd or related > companies. If you are not the intended recipient of this email, you > must neither take any action based upon its contents, nor copy or show > it to anyone. Please contact the sender if you believe you have received this > email in error. > Shape Blue Ltd is a company incorporated in England & Wales. ShapeBlue > Services India LLP is a company incorporated in India and is operated > under license from Shape Blue Ltd. Shape Blue Brasil Consultoria Ltda > is a company incorporated in Brasil and is operated under license from > Shape Blue Ltd. ShapeBlue is a registered trademark. > > This email and any attachments to it may be confidential and are > intended solely for the use of the individual to whom it is addressed. > Any views or opinions expressed are solely those of the author and do > not necessarily represent those of Shape Blue Ltd or related > companies. If you are not the intended recipient of this email, you > must neither take any action based upon its contents, nor copy or show > it to anyone. Please contact the sender if you believe you have received this > email in error. > Shape Blue Ltd is a company incorporated in England & Wales. ShapeBlue > Services India LLP is a company incorporated in India and is operated > under license from Shape Blue Ltd. Shape Blue Brasil Consultoria Ltda > is a company incorporated in Brasil and is operated under license from > Shape Blue Ltd. ShapeBlue is a registered trademark. > >
