IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2024-12-28 01:41:24 -06:00
Code Issues Packages Projects Releases Wiki Activity

Doc: Update documentation-style-guide.md (#29082)

Browse Source 
* Update documentation-style-guide.md

* Update documentation-style-guide.md
This commit is contained in:
Diana Payton 2020-11-13 07:33:33 -08:00 committed by GitHub
parent 1bdcd2f9ab
commit ec864f6461
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -51,8 +51,11 @@ The following sections provide general guidelines on topics specific to Grafana
### General
- Use active voice. Avoid passive voice.
- Active: Grafana displays the heatmap visualization.
- Passive: The heatmap visualization is displayed.
- Use active: Grafana displays the heatmap visualization.
- Avoid passive: The heatmap visualization is displayed.
- Write directly to the reader.
- Use: "After you create a dashboard, you can add a panel to it."
- Avoid: "After you create a dashboard, it is possible to add a panel to it."
- Write in the imperative second person. Examples: You can write a query. Click the panel. Close the window.
- Write in present tense.
- Use: The panel opens. Grafana opens the panel.