Add bold and italic format guidance (#384)

* Add bold and italic format guidance * Add trailing newline Signed-off-by: Jack Baldry <[email protected]> * Update docs/sources/write/style-guide/style-conventions/index.md Co-authored-by: J Stickler <[email protected]> * Update docs/sources/write/style-guide/style-conventions/index.md Co-authored-by: Jack Baldry <[email protected]> * Update docs/sources/write/style-guide/style-conventions/index.md Co-authored-by: J Stickler <[email protected]> --------- Signed-off-by: Jack Baldry <[email protected]> Co-authored-by: Jack Baldry <[email protected]> Co-authored-by: J Stickler <[email protected]>
grafana · Jan 12, 2024 · 55e1a9a · 55e1a9a
1 parent c7386dc
commit 55e1a9a
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/docs/sources/write/style-guide/style-conventions/index.md b/docs/sources/write/style-guide/style-conventions/index.md
@@ -253,3 +253,19 @@ When you write in active voice, you identify the subject of the sentence and the
 
 The output is the same in both cases.
 However, the first is easier to review and edit and is less subject to the screen and text editor settings of each contributor.
+
+## Text formatting
+
+It's a good idea to take a consistent approach to bold, italic, and other text formats.
+
+### Bold
+
+Use bold formatting (\*\* in Markdown), for UI elements. Don't use bold to draw attention to a word or phrase.
+
+### Italic
+
+Use italics formatting (\_ in Markdown), to emphasize a specific word or phrase. This is particularly useful when defining a term for the first time.
+
+For example:
+
+> The Prometheus data model is arranged into _metrics_ that consist of a _timestamp_ and a _sample_.