Knife role documentation is missing documentation for 10 commands
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 <role: Developer, SysAdmin, etc.>, I want to be able to use the documentation on knife and have it be complete an accurate.
Description
The knife role documentation is missing large portions of the CLI. The web page has 7 commands listed. Chef Workstation ships with 17 commands.
https://docs.chef.io/workstation/knife_role
> knife role
** ROLE COMMANDS **
knife role bulk delete REGEX (options)
knife role create ROLE (options)
knife role delete ROLE (options)
knife role edit ROLE (options)
knife role env_run_list add [ROLE] [ENVIRONMENT] [ENTRY [ENTRY]] (options)
knife role env_run_list clear [ROLE] [ENVIRONMENT] (options)
knife role env_run_list remove [ROLE] [ENVIRONMENT] [ENTRIES] (options)
knife role env_run_list replace [ROLE] [ENVIRONMENT] [OLD_ENTRY] [NEW_ENTRY] (options)
knife role env_run_list set [ROLE] [ENVIRONMENT] [ENTRIES] (options)
knife role from file FILE [FILE..] (options)
knife role list (options)
knife role run_list add [ROLE] [ENTRY [ENTRY]] (options)
knife role run_list clear [ROLE] (options)
knife role run_list remove [ROLE] [ENTRY] (options)
knife role run_list replace [ROLE] [OLD_ENTRY] [NEW_ENTRY] (options)
knife role run_list set [ROLE] [ENTRIES] (options)
knife role show ROLE (options)
Chef Version
The latest
Platform Version
Any
Definition of Done
All the knife role commands are documented.
Demo Script / Repro Steps
View https://docs.chef.io/workstation/knife_role and compare it to knife role CLI
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 https://docs.chef.io/workstation/knife_role and compare its documented commands with the provided knife role CLI output. Document the missing commands and verify that all 17 listed knife role commands are covered; the Definition of Done is complete knife role command documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100