public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source 
closes #19404
closes #19281
This commit is contained in:
Robert Lowry
2019-10-08 23:22:30 +02:00
committed by Marcus Olsson
parent 862f2e4821
commit b0bf2ea09f
2 changed files with 7 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
contribute/documentation.md
+4 -4
View File
@@ -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.