Make special notes about and document behavior of the cookbook attribute
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
The cookbook attribute found in the template and cookbook_file should have some more specific notes in their respective resource documents to talk about how Chef resolves the location of a source file.
The Custom Resources example section should also make special note of this since the template resource is used. I think it should talk about if you use the website resource in another cookbook that it will have to define the cookbook attribute and maybe provide an example.
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
Start by reading the existing template and cookbook_file resource documentation, then review the Custom Resources example section. Document how Chef resolves a source file location, explain when the cookbook attribute is needed for a resource used from another cookbook, and include an example showing that usage.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100