diff --git a/contribute/documentation.md b/contribute/documentation.md index 63f3de50e54..ed6a900dc0c 100644 --- a/contribute/documentation.md +++ b/contribute/documentation.md @@ -35,8 +35,8 @@ For each section, a `_index.md` file is used to provide an overview of the topic ### Style guide -The [codespell](https://github.com/codespell-project/codespell) tool is run for every change to catch common misspellings. +A [style guide](https://github.com/grafana/grafana/blob/master/style_guides/documentation-style-guide.md), which applies to all documentation created by the Grafana project, is located in the [Grafana GitHub repository](https://github.com/grafana/grafana). + +### Spelling -- "Open source" should be hyphenated when used as an adjective, e.g. _open-source software_. The open form should be preferred when used as a noun, e.g. _Grafana is open source_. -- Use "data source" instead of "datasource" unless used as an identifier, in code or as part of URLs. -- Acronyms should be uppercased, e.g. URL, DNS, or TCP/IP. +The [codespell](https://github.com/codespell-project/codespell) tool is run for every change to catch common misspellings. diff --git a/contribute/style-guides/documentation-style-guide.md b/contribute/style-guides/documentation-style-guide.md index d9833136afd..fc6164ba115 100644 --- a/contribute/style-guides/documentation-style-guide.md +++ b/contribute/style-guides/documentation-style-guide.md @@ -73,10 +73,6 @@ When possible, use the exact title of the page or section you are linking to as Grafana products has some words, abbreviations, and slang particular to this discourse community. -#### data source - -Two words, not one - -**Exceptions:** -* "datasource" used as an identifier -* "datasource" in a URL +* "Open source" should be hyphenated when used as an adjective, e.g. *open-source software*. The open form should be preferred when used as a noun, e.g. *Grafana is open source*. +* Use "data source" instead of "datasource" unless used as an identifier, in code, or as part of a URL. +* Spell out "repository" and avoid the shorter "repo."