Feedback Need: Charm Author Docs

[Antonio Rosales]

On Fri, Jul 12, 2013 at 10:14 AM, Robbie Williamson
<robbie.williamson at canonical.com> wrote:
> On 07/12/2013 03:25 AM, Nick Veitch 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
>> A breakdown of the parts in a charm (possibly more than one page)
>> A coherent step by step on creating a simple charm
>> A number of extra pages on more specific, advanced topics (e.g. hook
>> debugging, whenever that feature lands for core)
>>
>
> +1
>
> Depending on how long that takes to do, could we move the anatomy info
> into the start of the charm writing section in the short term?

To follow up on this thread, I chatted with Nick V. and if we bypass
moving anatomy into charm writing we should be able to get the new
structure (intro, overview, step-by-step, advanced topics) done by end
of week.  As a plus this help with the redirect story, and not
changing the docs too much on users.

Feedback welcome on the current approach and docs in general.

-Thanks,
Antonio

>
> -Robbie
>
>>
>>
>> On Fri, Jul 12, 2013 at 7:01 AM, Antonio Rosales
>> <antonio.rosales at canonical.com <mailto:antonio.rosales at canonical.com>>
>> wrote:
>>
>>     In discussing the new docs we came across a question that required
>>     additional feedback.  In regards to easy-of-use would charm authors
>>     like to see https://juju.ubuntu.com/docs/authors-charm-anatomy.html
>>     and https://juju.ubuntu.com/docs/authors-charm-writing.html combined
>>     into one page or further split out?  The end goal is to make
>>     navigation easy for charm authors looking for content they need as
>>     they develop charms.
>>
>>     Thanks,
>>     -Antonio
>>
>>     --
>>     Juju mailing list
>>     Juju at lists.ubuntu.com <mailto:Juju at lists.ubuntu.com>
>>     Modify settings or unsubscribe at:
>>     https://lists.ubuntu.com/mailman/listinfo/juju
>>
>>
>>
>>
>
>
> --
> Robbie Williamson <robbie.williamson at canonical.com>
> Vice President, Cloud Development and Operations
> Canonical Ltd.
>
> "You can't be lucky all the time, but you can be smart everyday"
>  -16 Blocks by Richard Wenk