From 55e1a9a29a29b7ed11f1f2e0f1b8e5f8fc372cec Mon Sep 17 00:00:00 2001 From: Joseph Perez <45749060+josmperez@users.noreply.github.com> Date: Fri, 12 Jan 2024 13:11:24 -0800 Subject: [PATCH] Add bold and italic format guidance (#384) * Add bold and italic format guidance * Add trailing newline Signed-off-by: Jack Baldry * Update docs/sources/write/style-guide/style-conventions/index.md Co-authored-by: J Stickler * Update docs/sources/write/style-guide/style-conventions/index.md Co-authored-by: Jack Baldry * Update docs/sources/write/style-guide/style-conventions/index.md Co-authored-by: J Stickler --------- Signed-off-by: Jack Baldry Co-authored-by: Jack Baldry Co-authored-by: J Stickler --- .../write/style-guide/style-conventions/index.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/sources/write/style-guide/style-conventions/index.md b/docs/sources/write/style-guide/style-conventions/index.md index f83950363..b98106ce8 100644 --- 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_.