Lint the docs for names, address, emails, IPs, according to practices in the styleguide
Open
Nobody has claimed this yet.
Aspect: Documentation
Type: Docs Debt
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
User Story
As a <role: Developer, SysAdmin, etc.>, I will use this work when I want to ...
Description
<! Briefly describe the issue >
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
The issue names no files, tests, entry points, Chef version, platform, or concrete definition of done. Start by locating the documentation styleguide and any existing lint configuration, then establish the intended scope for names, addresses, emails, and IPs; done should be a documented, reproducible lint result covering that scope.
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
- 15/100