mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
Docs: Add "repository" case, and "open source" to style guide
closes #19404 closes #19281
This commit is contained in:
parent
862f2e4821
commit
b0bf2ea09f
@ -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).
|
||||
|
||||
- "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.
|
||||
### Spelling
|
||||
|
||||
The [codespell](https://github.com/codespell-project/codespell) tool is run for every change to catch common misspellings.
|
||||
|
@ -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."
|
||||
|
Loading…
Reference in New Issue
Block a user