action_class documentation incorrect
Open
Nobody has claimed this yet.
Aspect: Documentation
Component: Chef Infra Client
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
I just notices that the current documentation for the custom resource action_class doesn't seem to have anything to do with using the action_class.
https://docs.chef.io/dsl_custom_resource/#action_class
https://github.com/chef/chef-web-docs/blob/9b8a11d0d0b384c9b424dc976e8b9bc1e614b13d/content/custom_resources.md
@tas50 - FYI
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
Compare the rendered action_class section at docs.chef.io/dsl_custom_resource/#action_class with content/custom_resources.md at the linked revision. Confirm what the custom resource action_class does, then update the documentation so that section accurately explains its use and verify the rendered wording is consistent.
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
- Mostly clear
- Newbie friendliness
- 55/100