chef / chef/chef-web-docs

Modernize Core Chef Infra Docs

Open
#2,145 0 comments 0 reactions 1 assignee View on GitHub

@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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.