mirror of
https://github.com/grafana/grafana.git
synced 2025-01-24 23:37:01 -06:00
Update documentation-style-guide.md (#32959)
This commit is contained in:
parent
2808f4b034
commit
50ab6155ff
@ -46,7 +46,7 @@ Avoid _master_ or _slave_.
|
|||||||
|
|
||||||
## Grafana-specific style
|
## Grafana-specific style
|
||||||
|
|
||||||
The following guidelines are specific to Grafana documentation. For the most part, these are *guidelines* are not rigid rules. If you have questions, ask in the #docs channel of Grafana Slack.
|
The following guidelines are specific to Grafana documentation. For the most part, these are *guidelines* are not rigid rules. If you have questions, then please ask in the #docs channel of Grafana Slack.
|
||||||
|
|
||||||
### General
|
### General
|
||||||
|
|
||||||
@ -118,6 +118,13 @@ If that is the case, then use the following format for headings:
|
|||||||
- Markdown image links are preferred. Only use the HTML image links if you need to style the image in ways unsupported in Markdown.
|
- Markdown image links are preferred. Only use the HTML image links if you need to style the image in ways unsupported in Markdown.
|
||||||
- When you name a file, follow the [file naming conventions](#file-naming-conventions). Example: image-name-7-3.png
|
- When you name a file, follow the [file naming conventions](#file-naming-conventions). Example: image-name-7-3.png
|
||||||
|
|
||||||
|
### Unordered lists
|
||||||
|
|
||||||
|
Here are a few general rules about unordered lists. For more guidance, refer to [Lists](https://developers.google.com/style/lists) in the [Google developer style guide](https://developers.google.com/style/).
|
||||||
|
|
||||||
|
- List items should begin with a capital letter unless there is a strong reason not to. For example, you are listing case-sensitive parameters.
|
||||||
|
- List items should end with periods if they are complete sentences. If one item in a list ends with a period, then apply periods to all of them.
|
||||||
|
|
||||||
### Capitalization
|
### Capitalization
|
||||||
|
|
||||||
- Grafana, Loki, and Prometheus are always capitalized unless part of a code block.
|
- Grafana, Loki, and Prometheus are always capitalized unless part of a code block.
|
||||||
|
Loading…
Reference in New Issue
Block a user