Document usage of arrays with resource actions
Open
Nobody has claimed this yet.
Aspect: Documentation
Component: Chef Infra Client
Topic: Resources
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
Something that is documented by example, but not explained is the usage of arrays with resource actions. It is also important to note the order as they are executed left to right so it would be helpful to note this somewhere in the common functionality docs would be my guess for a good location.
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
Read the execution order referenced in lib/chef/runner.rb#L98, then locate the common functionality documentation in this repository. Document how arrays work with resource actions and make the left-to-right execution order explicit; the documentation should explain both points by example or text.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100