`config.rb` docs don't mention walking PWD
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
User Story
As a user I want a general config in my repo rather than having everyone have to duplicate configs in their homedirectory. This already works today, chef and knife will walk up the PWD looking for config.rb... but the docs don't tell you this.
Description
The PWD-walking is not mentioned here: https://docs.chef.io/config_rb_client.html
Chef Version
Chefdk 0.7.4-1, chef 15.1.36
Platform Version
Ubuntu 18.04
Definition of Done
Its documented
Demo Script / Repro Steps
Read docs, see it's not there.
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 linked config_rb_client.html documentation page and inspect the section describing config.rb lookup. Add a note that chef and knife walk upward from the PWD to find a repository-level config.rb, then verify the page clearly states when this lookup applies.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100