[BUG] Fetcher and Reporters documentation needs clarification
Open
Nobody has claimed this yet.
Documentation
Status: Untriaged
Type: Bug
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
General details
Link to page and section that needs updated: https://github.com/chef/chef-web-docs/blob/main/content/chef_compliance_phase.md
Product
[ ] Chef Automate
[ ] Chef Habitat
[X] Chef Infra Client
[ ] Chef Infra Server
[ ] Chef InSpec
[ ] Other________________
Describe the update that needs to be made. Be as specific as possible:
Please clarify better the Fetcher and Reporters use.
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 content/chef_compliance_phase.md and locate the Fetcher and Reporters sections. Determine what usage details are missing, then clarify those sections so readers can understand how Fetchers and Reporters are used; verify the resulting documentation is complete and consistent with the surrounding page.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100