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

["steve ." < >]

I've used it successfully by following the README.  However, if you don't populate your cookbooks' metadata.rb, you won't see anything exciting.

I really like the idea of yard-chef, but in order for it to become truly, indispensably awesome we'd need for it to document attributes from a comment immediately preceding the first mention of the attribute and to parse a recipe's commented preamble as a docstring.  Those both seem to be pretty common patterns of usage both inside and outside our organization.

(and I'm another believer in making the code conform to what people are doing instead of the other way around, whenever possible ... :D )

On Fri, Apr 5, 2013 at 7:20 AM, John Alberts < " target="_blank"> > wrote:

Does anyone have any examples or tutorials for using yard-chef?  I glanced at some of the rightscale cookbooks, since they created yard-chef, and I don't see them using it in any of their cookbooks that I looked at.

On Fri, Apr 5, 2013 at 5:46 AM, Brian Akins < " target="_blank"> > wrote:

On Thu, Apr 4, 2013 at 7:42 AM, Mike < " target="_blank"> > wrote:

And until Chef Server has _anything_ to do with attributes in
metadata.rb, they are just "spam" and non-canonical, duplicated
attributes that may fall from accuracy/sync as time goes by.

+1

This is why I'm -1 on any documentation "standard" that  says put the documentation in some place other than in the attributes file. I've seen cookbooks here and there that have "documentation" in metadata.rb that has drifted from the attributes file(s).

--
John Alberts