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

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

Browse Source
This commit is contained in:
Diana Payton 2020-12-03 08:12:46 -08:00 committed by GitHub
parent 56db402d0f
commit b63e6959df
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -115,7 +115,6 @@ If that is the case, then use the following format for headings:
- 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.
- API names are always Title Case, followed by "API"—for example, "Dashboard Permissions API" - API names are always Title Case, followed by "API"—for example, "Dashboard Permissions API"
- Git is always capitalized, unless part of a code block.
- Abbreviations are always capitalized (such as API, HTTP, ID, JSON, SQL, or URL) unless they are part of a code block. - Abbreviations are always capitalized (such as API, HTTP, ID, JSON, SQL, or URL) unless they are part of a code block.
- Menu and submenu titles always use sentence case: capitalize the first word, and lowercase the rest. - Menu and submenu titles always use sentence case: capitalize the first word, and lowercase the rest.
- "Dashboards" when referring to the submenu title. - "Dashboards" when referring to the submenu title.
@ -125,6 +124,19 @@ If that is the case, then use the following format for headings:
- Lowercase "dashboards" when referring to multiple dashboards. - Lowercase "dashboards" when referring to multiple dashboards.
- **Exceptions:** If a term is lowercased in the Grafana UI, then match the UI. - **Exceptions:** If a term is lowercased in the Grafana UI, then match the UI.
#### Git, GitHub
Git is always capitalized, unless part of a code block. GitHub is the correct spelling and capitalization.
#### Integrations
In general, "integration" is not capitalized. Only capitalize it if it is capitalized in the UI or part of a proper noun, like the name of a specific integration.
**Examples:**
- MySQL Integration
- CockroachDB Integration
- I installed an integration on my local Grafana.
### Links and references ### Links and references
When referencing another document, use "Refer to" rather than alternatives such as "See" or "Check out." When referencing another document, use "Refer to" rather than alternatives such as "See" or "Check out."