knife acl is not documented on docs.chef.io
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 to understand and configure Chef software.
Description
The knife acl commands are not documented on docs.chef.io. There are references[1][2] and links to the knife-acl repo. That repo is archived and gives a warning that "This repo is no longer maintained"[3]. That implies that the documentation listed there is out of date and should not be trusted.
[1] https://docs.chef.io/server_orgs/#knife-acl
[2] https://docs.chef.io/workstation/knife/#chef-maintained-knife-plugins
[3] https://github.com/chef-boneyard/knife-acl
Chef Version
Chef Infra Client in 16.0+
Platform Version
N/A
Definition of Done
There should be a sub page under https://docs.chef.io/workstation/knife/ that describes and gives guidance for using knife acl commands.
Demo Script / Repro Steps
View https://github.com/chef-boneyard/knife-acl and take note that it is archived and says This repo is no longer maintained. Then look for official documentation on docs.chef.io and take note that there isn't any.
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 existing knife documentation at https://docs.chef.io/workstation/knife/ and compare its references to knife acl with the archived knife-acl repository. Add a subpage under the knife documentation that describes and gives guidance for the knife acl commands; the work is done when official documentation is available there for Chef Infra Client 16.0+.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100