[BUG] The value_for_platform help is difficult to understand from the docs
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
General details
https://docs.chef.io/infra_language/checking_platforms/#value_for_platform
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:
What would help the docs would be some actual examples using the code. The current examples that just use 'platform', 'version' and 'value' make it difficult to know if those are literal strings or values that should be replaced. It would be helpful to have an working example that shows off all the different options available.
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
Read the value_for_platform section at the linked Chef Infra documentation page first. Replace abstract placeholder-only examples with concrete working examples that clarify which values are literal and demonstrate the available options; done means the section is understandable without guessing how to adapt the examples.
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
- Clearly specified
- Newbie friendliness
- 58/100