How to Contribute to API Documentation (was RE: CloudStack API question)

[Jessica Tomechak <je...@gmail.com>]

If you're interested in adding or correcting information in the CloudStack
API Reference: first of all, thanks very much! We are lacking a dedicated
API writer, so any help will be very useful.

You might find the following page helpful:

http://wiki.cloudstack.org/display/TechPubs/How+to+Generate+CloudStack+API+Documentation


This was originally written for Cloud.com, and it refers to the continuous
build that Citrix uses, which I'm not sure is the same for Apache
CloudStack. Apologies for any differences there. I've opened the page up to
editing, so anyone with an account on the wiki can fix this to refer to the
correct Apache procedures.

I've linked this to Alena's annotations wiki page - thanks Alena!

Jessica T.
CloudStack Tech Pubs

-----Original Message-----
> From: Alena Prokharchyk [mailto:Alena.Prokharchyk@citrix.com]
> Sent: Tuesday, June 26, 2012 4:54 PM
> To: cloudstack-dev@incubator.apache.org
> Cc: Radhika Nair
> Subject: Re: CloudStack API question
>
> Here is the doc explaining @ usage in API commands / API responses:
>
> http://wiki.cloudstack.org/display/dev/Annotations+use+in+API
>
> -Alena.
>
>
> On 6/25/12 9:37 AM, "Alena Prokharchyk" <Al...@citrix.com>
> wrote:
>
> >I'll write something up, and let you know the wiki page location once
> >I'm done.
> >
> >-Alena.
> >
> >
> >On 6/25/12 4:23 AM, "Deepak Garg" <de...@citrix.com> wrote:
> >
> >>
> >>
> >>-----Original Message-----
> >>From: Prasanna Santhanam [mailto:prasanna.santhanam@citrix.com]
> >>Sent: Monday, June 25, 2012 1:45 PM
> >>To: cloudstack-dev@incubator.apache.org
> >>Cc: Radhika Nair
> >>Subject: Re: CloudStack API question
> >>
> >>On Fri, Jun 22, 2012 at 05:20:45PM -0400, Jessica Tomechak wrote:
> >>> Thanks to Amit for raising these API questions. I have noted the
> >>>answers in  in the documentation bug
> >>>http://bugs.cloudstack.org/browse/CS-12742,
> >>>"API
> >>> docs: Better describe parameters." I filed this bug myself last
> >>>January.
> >>> I'm sad to say the existing CloudStack tech writing team does not
> >>>have  enough resources to address it.
> >>>
> >>> Community contribution might be a good way to incrementally improve
> >>>these  descriptions. As you use the API, you will find out more about
> >>>the calls  you are using. This could be a good time to write those
> >>>answers down for  the next person.
> >>>
> >>> The API reference docs are implemented as annotations in the code.
> >>>I'd be  interested to hear from the community on this: do you feel
> >>>you can  understand how to update these annotations just by looking
> >>>at the code?
> >>>Or
> >>> would a wiki page on "how to edit the API reference annotations" be
> >>>helpful?
> >>>
> >>>  Jessica T.
> >>>
> >>> CloudStack Tech Pubs
> >>
> >>>> I think a wiki page explaining the annotation and how to use it
> >>>> will be quite helpful. I would be happy to send in patches with the
> >>>> corrections for the API.
> >>
> >>--
> >>>> Prasanna.,
> >>
> >>+1
> >>
> >>
> >>Deepak Garg
> >>
> >
> >
> >
>
>
>