- From: Ionuț Arțăriși <
- Subject: [chef] Chef cookbook documentation generator from attributes files
- Date: Thu, 10 Oct 2013 17:09:57 +0200
I started working on a project to generate README (markdown)
documentation from attributes files:
This project started while working on the openstack cookbooks. The
attributes files there have a lot of comments that would be useful for
users: which attributes are available to be configured and what they do,
how etc. This documentation also has the advantage of being more valid
and up-to-date since it is in the code.
README files don't get nearly as many changes as the comments in the
attributes files. However, the README is generally the frontpage of a
cookbook which users generally go to read. So it would make sense to
have the documentation mirrored from the attributes files.
chef-attrdoc looks at the attributes/default.rb file, groups blocks of
attribute assignments with the first comment above them and then inserts
all of this into the cookbook README's Attributes section.
I am aware of other tools which generate documentation from cookbook
filse, but they either do not use the attributes file as a source or
Here are some examples of generated attributes sections from openstack
This is a very early release with some known bugs. I'd really like to
know what the wider chef community thinks :)
- [chef] Chef cookbook documentation generator from attributes files, Ionuț Arțăriși, 10/10/2013
Archive powered by MHonArc 2.6.16.