(Doc) Explain creation of knife.rb for noobies
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- ruby
- Domain
- documentation
Research direction
Start by locating the README section that introduces knife.rb and compare it with the repository's existing Chef configuration. Update the documentation to explain the file location, complete contents, cookbook_path format, and meaning of node_name "solo". Done means a developer with little or no Chef experience can configure knife.rb without the listed ambiguities.
Written by the indexing model from the issue text.
Description
I'm approaching these docs from the standpoint of a basic developer who's maybe once used Chef, or maybe never. From that standpoint, it's not clear from the readme where knife.rb is supposed to be or what its total contents should be.
Ensure a knife.rb file is configured on your local machine:
node_name “solo”
data_bag_path "<cookbook_path>/data_bags"
Unclear:
- Where's knife.rb supposed to go? /path/to/this/repo on localhost, or under ~/.chef? Maybe /path/to/this/repo/cookbooks?
- Are the two lines above ALL that we need in knife.rb, or is more needed beyond just this? If so, what?
- Is "cookbook_path" above able to handle relative paths, or does it need to be absolute? In other words, can I use "./cookbooks", or should it be "/path/to/this/repo/cookbooks"?
- What's node_name "solo" mean? What if we're working with an environment that doesn't utilize a solo role machine in EY Classic? In other words, what's "solo" here - the machine role on which this is to be run, or...what?
- Dominant language
- Ruby
- Stars
- 3
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
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.
More from engineyard/eydr
-
Difficulty 2/5 1-3 hours Newbie friendliness 30/100
engineyard/eydr#6 · 1 comment ·
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
TheOdinProject/curriculum#31408 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
notch8/utk_knapsack#148 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
Homebrew/homebrew-cask#288729 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100