chef-web-docs
chef-web-docs copied to clipboard
Make placeholder names more explicit
People may get stuck putting in the literal text (or angle brackets) from placeholder values. Either a note or clarifying text should be added when using placeholders.
Probably multiple cards.
- What standard should we follow for placeholder values? (Check practice in MS Docs, Google Docs styleguides)
- Write a style guide entry
- Plan for implementation (probably one card for each repo)
- Implementation
- Write a Vale linter to check conformity
Food for thought: https://developers.google.com/style/placeholders