opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-08-02 11:52:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation-style-guide.md (#28037)

Browse Source
This commit is contained in:
Diana Payton
2020-10-05 12:03:12 -07:00
committed by GitHub
parent 1c865b5bcb
commit 81ec13b76d
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -61,6 +61,8 @@ The following sections provide general guidelines on topics specific to Grafana
- **Exceptions:** If an ampersand is used in the Grafana UI, then match the UI.
- Avoid using internal slang and jargon in technical documentation.
- Do not use two spaces after a period. Only add one space after each sentence. Do not add a space at the end of the paragraph.
- Sentence length should be 25 words or less. If your thought is longer than 25 words, consider breaking up the sentence or changing the format to a list.
- Paragraphs should be three sentences or fewer. Break up long paragraphs.
### File naming conventions