chef-web-docs icon indicating copy to clipboard operation
chef-web-docs copied to clipboard

Make placeholder names more explicit

Open davidwrede opened this issue 8 years ago • 2 comments

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.

davidwrede avatar Dec 03 '16 00:12 davidwrede

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

kagarmoe avatar Apr 15 '21 04:04 kagarmoe

Food for thought: https://developers.google.com/style/placeholders

IanMadd avatar Apr 15 '21 04:04 IanMadd