[chef] Re: Documenting Cookbooks

[Dimitri Aivaliotis < >]

Hi Peter,

On Wed, Apr 3, 2013 at 1:14 AM, Peter Donald 
<
 >
 wrote:
>
> So is this of interest to anyone else?

Thanks for this.  This definitely speaks to a pain point we have as well.

> Anyone have opinions on the best way to do this?

I agree with Brian that code should be documented with the code.  In
the case of attributes, though, the metadata spec we get from Opscode
doesn't seem to allow for this.  So, it would be a big win to be able
to document attributes in the attributes file(s) using the '#<>'
convention, then have the attribute specifications inserted into the
metadata file during the documentation phase (knife cookbook doc).

What do you think?  Would this be possible with the plugin?

- Dimitri