Document Chef Server's REST interface to the ACL subsystem
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
This location should probably have full documentation about the ACL subsystem. https://docs.chef.io/api_chef_server.html
Currently the only documentation for those functions is in https://github.com/chef/knife-acl
This explains at a very high level how the ACL system works https://github.com/chef/chef-server/blob/master/doc/ChefServerPermissions_v1.3.pdf
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 API documentation at docs.chef.io/api_chef_server.html, then review the existing ACL function documentation in the knife-acl repository and the ChefServerPermissions_v1.3.pdf overview. Done means the ACL subsystem's REST functions are documented in the Chef Server API documentation location.
Written by the indexing model from the issue text.
Assessment
- Domain
- authorization, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100