Document Cookbooks and Recipes
Open
Nobody has claimed this yet.
Documentation
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
The documentation needs a beginner's guide to writing cookbooks.
The cookbook guide probably contains:
- What is a cookbook? (Conceptual)
- How to use cookbooks from Supermarket (procedural)
- How to write a cookbook (Tutorial)
- Common Cookbook Patterns (Reference)
- So you want to update a cookbook (Guide)
The recipe guide probably contains:
- What is a recipe? (Conceptual)
- How to write a recipe (Tutorial)
- Common Recipes or patterns (Reference)
Product
- Chef Automate
- Chef Habitat
- Chef Infra Client
- Chef Infra Server
- Chef InSpec
- Other________________
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or documentation entry points are identified in the issue, so first locate the Chef Infra Client documentation structure and existing cookbook and recipe pages. Done means adding the requested conceptual, procedural, tutorial, reference, and guide content for cookbooks and recipes.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100