[chef] Re: Re: Aw: Re: Documenting Cookbooks

[Torben Knerr < >]

On Sat, Apr 6, 2013 at 4:23 AM, Peter Donald < " target="_blank"> > wrote:

 

On Wed, Apr 3, 2013 at 9:57 PM, Brian Akins < " target="_blank"> > wrote:

I've always been a big fan of documenting the code "with the code."  I find it odd to document the attributes in the metadata.rb rather than the attributes file(s). Same with recipes, etc. 

I agree. An early version of the plugin actually did this by executing the attribute files. I ran into problems where some of the cookbooks actually had logic in them - particularly when interacting with ohai data and this was difficult to mock out. In theory you could go back to a regex/extract approach but that also has it's own problems.

 

Maybe you can mock ohai using https://github.com/customink/fauxhai?

Cheers, Torben 

--
Cheers,

Peter Donald