Details
Improvement
Closed
Unknown
Description
"knife cookbook create blah" is a bit outdated. Things we might want to update:
1) use a README.md instead of README.rdoc. Markdown is preferred by TSE. metadata.rb would need to be updated to reflect.
2) update the default license in the default.rb recipe to be Apache 2 instead of "All Rights Reserved"? This may be open for debate.
3) do we still want libraries and definitions?
4) should we add data_bags and roles? See CHEF-2101
5) should the attributes/ dir have a default.rb, encouraging people to use a single attribute file?
(summary was: knife cookbook create needs updating)
1. Markdown is preferred by a great many people over rdoc, not just our team
.
2. Default license should stay non-distributable. Most people creating new cookbooks are probably doing so in their own infrastructure and don't need or intend to share.
3. Yes. Libraries are useful, and a powerful feature in Chef, despite not being common. Definitions are a necessity, despite being discouraged in our training material.
4. No. These are documentation artifacts, and redundant in most cases because people will just use the chef-repo's data_bags and roles directories.
5. No. Attributes files aren't as common "in the wild" as in Opscode's cookbooks. All attributes files are loaded anyway and the default is only relevant when doing "include_attribute".
So in other words, the default README should be markdown.