docs for knife search node cookbooks with cookbook_name & version
Open
Nobody has claimed this yet.
Aspect: Documentation
Component: Chef Infra Client
Topic: Knife
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
User Story
As a User, I want to search node with cookbook name and version.
Description
As per the docs knife_search seems "Search by cookbook" is missing in order to search the nodes with cookbook name & version.
Chef Version
NA
Definition of Done
Update the knife search docs in order to get the nodes that are being affected with cookbooks.
Demo Script / Repro Steps
In order to search the nodes with cookbook name & version following way we can do
- search with cookbook name only
knife search node 'cookbooks:COOKBOOK_NAME'
- search with cookbook name and version
knife search node 'cookbooks_COOKBOOK_NAME_version:VERSION'
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
Start with the knife_search documentation linked in the issue and review the existing search examples. Document node searches by cookbook name and by cookbook name plus version, then confirm the page's Definition of Done is met by ensuring both command forms are explained.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100