Cookbook documentation and yard-chef


#1

Hi everybody,

I was thinking about how to ensure that people are documenting their
cookbooks and came across a YARD Chef plugin that the folks at Rightscale
were working on (and may have abandoned?) about a year ago.

Anyway, it almost pretty much was in a working state so I gave it an extra
push and now have it serving documentation sites off of a Chef repository
and generating documentation coverage statistics.

So, if you haven’t solved this problem for yourself already, take a look:

If you have solved this problem already in a much more awesome way, I’d
love to hear about it and hopefully follow your example!


#2

This is interesting, I shall try it on the cookbook i am doing at the moment


Regards,
Alfredo Palhares


#3

Hey Steve,

Just a quick note to let you know that we have not abandoned this project.
Just putting some finishing touches on it (like support for README.md) and
hope to have the first version out soon. We will make a post to this
mailing list when it is ready to go. Please feel free to make pull
requests and/or open up new issues on this project as you find them.

Hope it works for ya’!

-Cary Penniman

On Tue, Oct 30, 2012 at 5:05 PM, steve . leftathome@gmail.com wrote:

Hi everybody,

I was thinking about how to ensure that people are documenting their
cookbooks and came across a YARD Chef plugin that the folks at Rightscale
were working on (and may have abandoned?) about a year ago.

Anyway, it almost pretty much was in a working state so I gave it an extra
push and now have it serving documentation sites off of a Chef repository
and generating documentation coverage statistics.

So, if you haven’t solved this problem for yourself already, take a look:

https://github.com/leftathome/yard-chef

If you have solved this problem already in a much more awesome way, I’d
love to hear about it and hopefully follow your example!


#4

Hi Cary,

Glad to hear the project is still being developed. I’ve made a few changes but they’re pretty minor (template bug fixes, etc).

I’m thinking of adding a parser for cookbook attribute files, since a lot of folks (myself included) don’t document attributes in the cookbook metadata.

Does this sound useful to the community or am I simply helping to propagate a bad practice? :slight_smile:

(I would potentially extend this to node.set() in recipes once we get our Chef 11 on.)

Looking forward to the next yard-chef release!

(mobile edition)

On Oct 31, 2012, at 5:48 AM, Cary Penniman cary@rightscale.com wrote:

Hey Steve,

Just a quick note to let you know that we have not abandoned this project. Just putting some finishing touches on it (like support for README.md) and hope to have the first version out soon. We will make a post to this mailing list when it is ready to go. Please feel free to make pull requests and/or open up new issues on this project as you find them.

Hope it works for ya’!

-Cary Penniman

On Tue, Oct 30, 2012 at 5:05 PM, steve . leftathome@gmail.com wrote:

Hi everybody,

I was thinking about how to ensure that people are documenting their cookbooks and came across a YARD Chef plugin that the folks at Rightscale were working on (and may have abandoned?) about a year ago.

Anyway, it almost pretty much was in a working state so I gave it an extra push and now have it serving documentation sites off of a Chef repository and generating documentation coverage statistics.

So, if you haven’t solved this problem for yourself already, take a look:

https://github.com/leftathome/yard-chef

If you have solved this problem already in a much more awesome way, I’d love to hear about it and hopefully follow your example!


#5

On Sat, Nov 3, 2012 at 12:08 AM, Steven Wagner leftathome@gmail.com wrote:

Hi Cary,

Glad to hear the project is still being developed. I’ve made a few
changes but they’re pretty minor (template bug fixes, etc).

I’m thinking of adding a parser for cookbook attribute files, since a lot
of folks (myself included) don’t document attributes in the cookbook
metadata.

Like it, encouraging documentation of attributes in metadata.rb is a good
thing :slight_smile:

Does this sound useful to the community or am I simply helping to
propagate a bad practice? :slight_smile:

(I would potentially extend this to node.set() in recipes once we get our
Chef 11 on.)

Looking forward to the next yard-chef release!

(mobile edition)

On Oct 31, 2012, at 5:48 AM, Cary Penniman cary@rightscale.com wrote:

Hey Steve,

Just a quick note to let you know that we have not abandoned this project.
Just putting some finishing touches on it (like support for README.md) and
hope to have the first version out soon. We will make a post to this
mailing list when it is ready to go. Please feel free to make pull
requests and/or open up new issues on this project as you find them.

Hope it works for ya’!

-Cary Penniman

On Tue, Oct 30, 2012 at 5:05 PM, steve . leftathome@gmail.com wrote:

Hi everybody,

I was thinking about how to ensure that people are documenting their
cookbooks and came across a YARD Chef plugin that the folks at Rightscale
were working on (and may have abandoned?) about a year ago.

Anyway, it almost pretty much was in a working state so I gave it an
extra push and now have it serving documentation sites off of a Chef
repository and generating documentation coverage statistics.

So, if you haven’t solved this problem for yourself already, take a look:

https://github.com/leftathome/yard-chef

If you have solved this problem already in a much more awesome way, I’d
love to hear about it and hopefully follow your example!


#6

I like the idea of the attribute parser. We do use the metadata in our
cookbooks, but only for attributes that we want to expose in our UI.
Ideally we would support attributes defined both in the attributes files
and as well as those in the metadata.

Any pull requests are greatly appreciated!

-Cary P

On Fri, Nov 2, 2012 at 4:08 PM, Steven Wagner leftathome@gmail.com wrote:

Hi Cary,

Glad to hear the project is still being developed. I’ve made a few
changes but they’re pretty minor (template bug fixes, etc).

I’m thinking of adding a parser for cookbook attribute files, since a lot
of folks (myself included) don’t document attributes in the cookbook
metadata.

Does this sound useful to the community or am I simply helping to
propagate a bad practice? :slight_smile:

(I would potentially extend this to node.set() in recipes once we get our
Chef 11 on.)

Looking forward to the next yard-chef release!

(mobile edition)

On Oct 31, 2012, at 5:48 AM, Cary Penniman cary@rightscale.com wrote:

Hey Steve,

Just a quick note to let you know that we have not abandoned this project.
Just putting some finishing touches on it (like support for README.md) and
hope to have the first version out soon. We will make a post to this
mailing list when it is ready to go. Please feel free to make pull
requests and/or open up new issues on this project as you find them.

Hope it works for ya’!

-Cary Penniman

On Tue, Oct 30, 2012 at 5:05 PM, steve . leftathome@gmail.com wrote:

Hi everybody,

I was thinking about how to ensure that people are documenting their
cookbooks and came across a YARD Chef plugin that the folks at Rightscale
were working on (and may have abandoned?) about a year ago.

Anyway, it almost pretty much was in a working state so I gave it an
extra push and now have it serving documentation sites off of a Chef
repository and generating documentation coverage statistics.

So, if you haven’t solved this problem for yourself already, take a look:

https://github.com/leftathome/yard-chef

If you have solved this problem already in a much more awesome way, I’d
love to hear about it and hopefully follow your example!


Cary Penniman
Sr. Software Developer
www.RightScale.com http://www.rightscale.com/

Phone: (805) 243-0222
Email: cary@rightscale.com
Skype: carypenniman