[BUG] Misleading documentation on package's allow_downgrade property
Nobody has claimed this yet.
- 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://docs.chef.io/resources/package/#properties
Product
- Chef Automate
- Chef Habitat
- Chef Infra Client
- Chef Infra Server
- Chef InSpec
- Other________________
Describe the update that needs to be made. Be as specific as possible:
Current docs say that allow_downgrade property is for yum_package resource only, which is not correct.
It was added for apt_package back in 2018: https://github.com/chef/chef/commit/9ee9facd4c0d51bc3b042edf644c450a9eaaa086
Many other package resources also have it: https://github.com/search?q=repo%3Achef%2Fchef%20allow_downgrade&type=code
The yum_package resource only note should either be removed completely or replaced with actual supported resources.
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 package resource properties section at the linked docs page and compare its allow_downgrade note with the referenced Chef commit and code search. Done means the documentation no longer incorrectly limits the property to yum_package and accurately reflects the supported package resources.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100