Skip to content

Commit 8cc95a7

Browse files
josmperezjdbaldry
andauthored
Docs: Edit contribute/style-guides (part 11 of doc improvement project) (grafana#92169)
* Docs: edit contribute/style-guides * Add missing 'is' * Improve grammar of code comment * Prettier fixes * Minor fix * Minor fix --------- Co-authored-by: Jack Baldry <[email protected]>
1 parent ca66133 commit 8cc95a7

File tree

4 files changed

+225
-232
lines changed

4 files changed

+225
-232
lines changed

contribute/engineering/terminology.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,14 @@
22

33
<!-- Keep terms in alphabetical order: -->
44

5-
This document defines technical terms used in Grafana.
5+
This glossary defines technical terms used in Grafana.
66

77
## TLS/SSL
88

99
The acronyms [TLS](https://en.wikipedia.org/wiki/Transport_Layer_Security) (Transport Layer Security) and
10-
[SSL](https://en.wikipedia.org/wiki/SSL) (Secure Socket Layer) are both used to describe the HTTPS security layer,
11-
and are in practice synonymous. However, TLS is considered the current name for the technology, and SSL is considered
10+
[SSL](https://en.wikipedia.org/wiki/SSL) (Secure Socket Layer) are both used to describe the HTTPS security layer.
11+
In practice, they are synonymous. However, TLS is considered the current name for the technology, and SSL is considered
1212
[deprecated](https://tools.ietf.org/html/rfc7568).
1313

14-
As such, while both terms are in use (also in our codebase) and are indeed interchangeable, TLS is the preferred term.
15-
That said however, we have at Grafana Labs decided to use both acronyms in combination when referring to this type of
16-
technology, i.e. _TLS/SSL_. This is in order to not confuse those who may not be aware of them being synonymous,
17-
and SSL still being so prevalent in common discourse.
14+
As such, while we use both terms in our codebase and documentation, we generally prefer TLS.
15+
However, we use both acronyms in combination when referring to this type of technology, that is, _TLS/SSL_. We do this because we don't want to confuse readers who may not be aware of them being synonymous, and SSL is still prevalent in common discourse.

0 commit comments

Comments
 (0)