Document the Knife CLI
Open
Nobody has claimed this yet.
Aspect: Documentation
Topic: Knife
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
User Story
Knife is one of our most important tools. Unfortunately, the Ruby CLIs don't auto-document. We need to have current and complete CLI documentation.
Related Issues
https://github.com/chef/chef-web-docs/issues/2982
@Dishank compiled a preliminary list
Description
- List of missing commands from comparing the docs to the CLI output
- List of missing commands from comparing the docs to the knife files
- Discuss with product manager to triage [scope of work]
- Document
Definition of Done
Meet the scope of work.
Demo Script / Repro Steps
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 by reviewing the existing Knife documentation, the CLI output, and the knife files, using the preliminary list from @Dishank and related issue chef/chef-web-docs#2982. Compare these sources to identify missing commands, then discuss the scope with the product manager before documenting the agreed set. Done means the agreed scope is fully documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100