{"id":419,"date":"2015-08-18T16:20:57","date_gmt":"2015-08-18T16:20:57","guid":{"rendered":"http:\/\/www.scmgalaxy.com\/tutorials\/2015\/08\/18\/chef-documenting-cookbooks-automatically\/"},"modified":"2021-11-19T07:04:07","modified_gmt":"2021-11-19T07:04:07","slug":"chef-documenting-cookbooks-automatically","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/chef-documenting-cookbooks-automatically\/","title":{"rendered":"Understanding the chef cookbook’s README file"},"content":{"rendered":"

Problems Area –<\/strong><\/p>\n

Our infrastructure has many cookbooks that aim to be reusable, primarily through encapsulating behaviour in LWRPs. This led to an explosion of LWRPs and sometimes the documentation didn’t keep up or did just not exist.<\/p>\n

Solution 1: Follow Best Practices <\/strong><\/p>\n

This command will create a README.rdoc by default, and I prefer Markdown, so I specify the -r md option.<\/p>\n

> knife cookbook create smartmontools -r md<\/pre>\n
Solution 2: Automate using plugins<\/strong><\/p>\n
README.md which should be generated automatcially must contain information about the recipes, attributes, platform compatibility and cookbook requirements (i.e. depends, recommends, suggests etc).<\/p>\n
Mathias Lafeldt wrote a knife plugin that generates an initial README.md from the metadata.rb file in a a cookbook.<\/p>\n
Link –<\/p>\n