search

grafana / killercoda

This repository holds tutorials designed and hosted on Killercoda and interactive education platform.
https://killercoda.com/
Apache License 2.0
2 stars 4 forks source link

Lint README for Writers' Toolkit style and link to transformer documentation #9

Closed jdbaldry closed 1 week ago

jdbaldry commented 2 weeks ago
  1. Use sentence case for headings
  2. Prefer "Before you begin" over "Prerequisites"
  3. Only use bold for referring to UI elements https://grafana.com/docs/writers-toolkit/write/style-guide/style-conventions/#bold
  4. Avoid exclamation marks
  5. Avoid "please": https://developers.google.com/style/word-list#please

Also add links to resources for performing task steps.