[chef] Re: Re: Re: documentation tool for chef cookbooks


Chronological Thread 
  • From: "steve ." < >
  • To:
  • Subject: [chef] Re: Re: Re: documentation tool for chef cookbooks
  • Date: Mon, 10 Dec 2012 11:16:04 -0800

I did a brief survey of tools a few months ago and yard-chef seemed to be the best available option (in terms of being the most intuitive blend of presentation and implementation).  There's definitely some improvements that need to happen before it can really be what I would call an indispensable tool to add to your pipeline.  I just haven't had the time to dig into figuring out all the parser stuff necessary to get attribute documentation working the way most of us internally are documenting them (i.e., not in metadata.rb but in the individual attributes files).  The docstring coverage reports are awesome, though.

Really looking forward to the next formal release of yard-chef, though.  :D


On Mon, Dec 10, 2012 at 7:25 AM, Oleg Volotov < " target="_blank"> > wrote:

Ok this one option, but are there some other tools, too?

> > I don't know, but give it some tools to auto generate documentation
> files in md, html or something else for my cookbooks?
> There is yard-chef[1] not sure about how functional it is tough
>
> [1] https://github.com/rightscale/yard-chef




Archive powered by MHonArc 2.6.16.

§