Skip to content

Commit

Permalink
Docs: Add kebab case and single pane of glass to word list (#862)
Browse files Browse the repository at this point in the history
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
  • Loading branch information
imatwawana and github-actions[bot] authored Oct 1, 2024
1 parent 62d192a commit 5ec1add
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/sources/whats-new.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,13 @@ weight: 175

This page provides a summary of notable changes to Writers' Toolkit guidance.

## October 2024

| New guidance or change | Page |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| Added _kebab case_ and _single pane of glass_ to word list. | [Word list - kebab case](/docs/writers-toolkit/write/style-guide/word-list/#kebab-case) & |
| [Word list - single pane of glass](/docs/writers-toolkit/write/style-guide/word-list/#single-pane-of-glass) |

## September 2024

| New guidance or change | Page |
Expand Down
17 changes: 17 additions & 0 deletions docs/sources/write/style-guide/word-list/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,17 @@ Use this rather than _hold the pointer over_ or _point to_.
<!--
## I
## J
-->

## K

### kebab case

Use this to refer to the naming convention where spaces between lower case words are replaced with dashes.```

Use this instead of _dash case_.

<!--
## L
-->

Expand Down Expand Up @@ -232,6 +242,13 @@ This aligns with Marketing and various other parts of <https://grafana.com>.

<!-- vale Grafana.SelfManaged = YES -->

### single pane of glass

This term should only be used in marketing materials. In technical documentation, use the following alternatives:

- _single interface_
- _unified interface_

### SQL (Structured Query Language)

The article, _a_ or _an_, that you use before the acronym _SQL_ depends on how the word is pronounced.
Expand Down

0 comments on commit 5ec1add

Please sign in to comment.