Turn chef-examples custom cookstyle content into documentation
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
User Story
Our docs should explain how to use our products.
Description
Add documentation on writing custom cops based on:
https://github.com/chef-cft/chef-examples/blob/master/examples/WorkstationWriteBasicCookstyle.md
Chef Version
<! Tell us which version of Chef Infra/Workstation/InSpec you need docs for) >
Platform Version
<! Tell us which Operating System distribution and version you're running a Chef product on. >
Definition of Done
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 reading the linked chef-examples WorkstationWriteBasicCookstyle.md and inspecting the chef-web-docs repository’s existing custom-cop documentation. Identify the appropriate documentation location and conventions before drafting the explanation. Done means the docs clearly explain how to write custom cops based on the referenced example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- hugo, markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100