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


Chronological Thread 
  • From: Jeff Blaine < >
  • To:
  • Subject: [chef] Re: Re: Re: Re: Re: Documenting Cookbooks
  • Date: Thu, 04 Apr 2013 09:27:21 -0400

I'm going to look at promoting/working with yard-chef more to achieve
the approach of documentation in the source, which renders html on the
side.

"YARD does not impose a specific markup. ... YARD also supports
textile and markdown via the command-line switch or .yardopts file"

Sounds good to me.

Above all, I think it's essential to the Chef community/ecosystem
that there's 1 acknowledged and recommended way to do cookbook
documentation.



Archive powered by MHonArc 2.6.16.

§