On Fri, Apr 5, 2013 at 2:05 AM, Sebastien Goasguen <run...@gmail.com> wrote:

>
>
> FYI, in case you missed it, I wrote a chapter in the dev guide on how to
> write docs….
>
>
Sebastien,
I missed your "how to write docs" chapter at first, but noticed it in the
last month. I haven't done a close review, though. It basically covers the
same ground as our Doc Contributor's Wiki, plus some material from the
Publican User Guide, right?

I have been wondering whether it belongs in the Developer's Guide. The
Developer's Guide was intended for CS users who want to call the CS API,
like cloud owners who want to automate provisioning or get stats about the
cloud. The how-to-write-docs chapter seems like it's aimed at people who
are developing CS itself. The original intended audience of the book
shouldn't need to contribute to our docs...or should they?

Maybe the problem is the book title. It's been causing confusion ever since
CloudStack went into Apache. It should really be called "Using the
CloudStack API" or "Writing Applications On CloudStack" or something of
that nature.

OR else, perhaps we want to make this book aim at ACS community, rather
than CS users. Either way, it needs a discussion, I think. Comments anyone?

Jessica T.

Reply via email to