opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-31 20:32:19 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated documentation style guide (#28488)

Browse Source 
* Added node_exporter to the list of words to use in Grafana documentation style guide

* Update contribute/style-guides/documentation-style-guide.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
This commit is contained in:
achatterjee-grafana
2020-10-23 11:35:12 -04:00
committed by GitHub
parent 8327dd500f
commit b6bb069e08
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
contribute/style-guides/documentation-style-guide.md
View File

@ -223,6 +223,13 @@ Do not hyphenate when it is used as a noun. For example: _Open source is the bes
Two words if used as a verb, one word if used as a noun. Two words if used as a verb, one word if used as a noun.
### node_exporter, windows_exporter
When referencing the Prometheus data source exporters, always use "node_exporter" and "windows_exporter" when referring to those tools.
**Correct:** node_exporter, windows_exporter
**Incorrect:** Node Exporter, node exporter, Windows Exporter, Windows exporter, windows exporter
**Examples** **Examples**
- Set up the workspace. - Set up the workspace.