Document the authentication property in remote_file resource
Open
Nobody has claimed this yet.
Aspect: Documentation
Component: Chef Infra Client
Topic: Resources
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
User Story
As a Sysadmin, I want to find out how to pass authentication information in a remote_file resource
Description
We have a property that's missing from the docs
Chef Version
Latest
Platform Version
N/A
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 locating the remote_file resource documentation and identifying the missing authentication property. Document how users pass authentication information, then verify that the resource documentation clearly explains the supported usage.
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
- 45/100