`config.rb` docs don't document `role_path` or `databag_path`
Open
Beginner friendly
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
User Story
cookbook_path is documented, so should the other ones be
Description
here https://docs.chef.io/config_rb.html
Chef Version
15.1.36
Platform Version
Ubuntu
Definition of Done
It's documented
Demo Script / Repro Steps
Open the docs, use eyeballs to see no reference to role_path or data_bag_path
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
Open the config.rb documentation at https://docs.chef.io/config_rb.html and search for the existing cookbook_path entry. Document role_path and data_bag_path alongside the other config.rb paths, then confirm both names and their descriptions are visible on the page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100