Modernize Core Chef Infra Docs
Open
@kagarmoe is already working on this.
Since Sep 25, 2019.
Aspect: Documentation
Topic: API
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
User Story
As a Chef Infra user, the essential conceptual and procedural documentation should be correct and current.
Description
We've made great progress in updating chef-web-docs through automation. The core conceptual and procedural documentation still lags behind. We need to update this set of essential documentation.
Definition of Done
- Use Chef Workstation not ChefDK
- Setup Client and Server is correct
- Bootstrap via knife is correct and repeatable
- Bootstrap on cloud usage exists, is correct, and covers terraform / packer and cloud-init
- I can use Policyfiles to create, update, and remove a policyfile.
- Environments recommends policyfiles, but I can also use it to create, update, and remove an environment
- Roles recommends policyfiles, but I can also use it to create, update, and remove a role
- CLI documentation is correct and current
- API documentation is correct and current.
Time
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.
Assessment
This issue has not been assessed yet.