Attributes should make sense
Open
Nobody has claimed this yet.
Aspect: Documentation
Component: Chef Infra Client
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
User Story
As a new Chef Infra user I should be able to use attributes by following the docs.
Definition of Done
- Explanation of attributes makes sense
- Reference material for attributes is correct, complete, and current
- Procedure for using attributes is correct, complete, and current
- Random attribute documentation does not litter the docsbase
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
The issue does not name files, tests, or an entry point. Locate the Chef Infra attribute documentation, then review its explanation, reference material, usage procedure, and scattered attribute content against the definition of done; completion requires all four areas to be correct, current, complete, and consolidated.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100