Commit b0bf2ea0 by Robert Lowry Committed by Marcus Olsson

Docs: Add "repository" case, and "open source" to style guide

closes #19404
closes #19281
parent 862f2e48
...@@ -35,8 +35,8 @@ For each section, a `_index.md` file is used to provide an overview of the topic ...@@ -35,8 +35,8 @@ For each section, a `_index.md` file is used to provide an overview of the topic
### Style guide ### 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_. The [codespell](https://github.com/codespell-project/codespell) tool is run for every change to catch common misspellings.
- 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.
...@@ -73,10 +73,6 @@ When possible, use the exact title of the page or section you are linking to as ...@@ -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. Grafana products has some words, abbreviations, and slang particular to this discourse community.
#### data source * "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.
Two words, not one * Spell out "repository" and avoid the shorter "repo."
**Exceptions:**
* "datasource" used as an identifier
* "datasource" in a URL
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment