Feedback Need: Charm Author Docs

[Antonio Rosales]

On Fri, Jul 12, 2013 at 3:25 AM, Nick Veitch <nick.veitch at canonical.com> wrote:
> Much of the authors section is a reformatted version of the old docs. One of
> the problems with the old docs were that the navigation and structure was
> confusing, and these two sections are a prime example of that. My intended
> restructure of this part would be:
>
> An introduction
> An overview of how charms work
+1 on an intro and overview to get an idea and snapshot of what a
charm is before folks dive in, and for advanced charm authors they may
not want to always scroll past the overview to get to the reference
sections they are looking for.

> A breakdown of the parts in a charm (possibly more than one page)
> A coherent step by step on creating a simple charm
+1 on having the breakdown of the parts of a charm possibly just as
reference in a different page than a step-by-step. I can see more
advanced charmers coming back for reference and not always wanting to
step through examples, and the example being essential to new
charmers.

> A number of extra pages on more specific, advanced topics (e.g. hook
> debugging, whenever that feature lands for core)
As new features land in Juju core we'll keep the docs sync'ed up with
the latest release notes. Also if any folks would like to see other
content (helpers, testing, etc.) be sure to bring it up on the list so
we can add it to the upcoming work in the blueprint[0], and/or feel
free to whip together a merge request. :-)

[0] https://blueprints.launchpad.net/ubuntu/+spec/servercloud-s-juju-docs

-thanks,
Antonio