ChefSpec docs need to be updated or removed
Open
Nobody has claimed this yet.
Aspect: Documentation
Priority: Medium
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
The ChefSpec docs on the docs site are giving examples that use the old ChefSpec format we don't want folks to be using at this point. We need to either update these docs are just point people to the ChefSpec readme.
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 linked docs page at docs.chef.io/chefspec.html and compare its examples with the ChefSpec README. Confirm whether the page should be updated or removed, then ensure the published documentation no longer promotes the old ChefSpec format and points readers to current guidance.
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
- Mostly clear
- Newbie friendliness
- 35/100