From b63e6959df63c43f701fe5150b4df195194e1f4d Mon Sep 17 00:00:00 2001 From: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> Date: Thu, 3 Dec 2020 08:12:46 -0800 Subject: [PATCH] Update documentation-style-guide.md (#29580) --- .../style-guides/documentation-style-guide.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/contribute/style-guides/documentation-style-guide.md b/contribute/style-guides/documentation-style-guide.md index 3e224196276..7bd5b4d0af0 100644 --- a/contribute/style-guides/documentation-style-guide.md +++ b/contribute/style-guides/documentation-style-guide.md @@ -115,7 +115,6 @@ If that is the case, then use the following format for headings: - Grafana, Loki, and Prometheus are always capitalized unless part of a code block. - API names are always Title Case, followed by "API"—for example, "Dashboard Permissions API" -- Git is always capitalized, unless part of a code block. - Abbreviations are always capitalized (such as API, HTTP, ID, JSON, SQL, or URL) unless they are part of a code block. - Menu and submenu titles always use sentence case: capitalize the first word, and lowercase the rest. - "Dashboards" when referring to the submenu title. @@ -125,6 +124,19 @@ If that is the case, then use the following format for headings: - Lowercase "dashboards" when referring to multiple dashboards. - **Exceptions:** If a term is lowercased in the Grafana UI, then match the UI. +#### Git, GitHub + +Git is always capitalized, unless part of a code block. GitHub is the correct spelling and capitalization. + +#### Integrations + +In general, "integration" is not capitalized. Only capitalize it if it is capitalized in the UI or part of a proper noun, like the name of a specific integration. + +**Examples:** +- MySQL Integration +- CockroachDB Integration +- I installed an integration on my local Grafana. + ### Links and references When referencing another document, use "Refer to" rather than alternatives such as "See" or "Check out."