diff options
| author | Bob Killen <bob.killen@linux.com> | 2020-01-26 08:55:53 -0500 |
|---|---|---|
| committer | Bob Killen <bob.killen@linux.com> | 2020-01-26 08:55:53 -0500 |
| commit | aaa3203aabdf1509bb086729ca86abdda651d926 (patch) | |
| tree | b5ac80be3d238ae69e7692b82fa2e349181c32ee /contributors/guide/style-guide.md | |
| parent | e17e9aa8b9d0bcee24e05223a943e417eecceaa1 (diff) | |
Update style guide with a note on how to refer to Kubernetes Groups.
Diffstat (limited to 'contributors/guide/style-guide.md')
| -rw-r--r-- | contributors/guide/style-guide.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/contributors/guide/style-guide.md b/contributors/guide/style-guide.md index 0444c5ba..23a803b3 100644 --- a/contributors/guide/style-guide.md +++ b/contributors/guide/style-guide.md @@ -103,6 +103,8 @@ These are **guidelines**, not rules. Use your best judgement. - If using acronyms, ensure they are clearly defined in the same document. - If using an abbreviation, spell it out the first time it is used in the document unless it is commonly known. (example: TCP/IP) +- When referring to a Kubernetes Group (SIG, WG, or UG) do not use the hyphenated + form unless it is for a specific purpose such as a file-name or URI. **[Moving a Document:](#moving-a-document)** @@ -389,6 +391,10 @@ external appearance. - **Good example:** A _CustomResourceDefinition_ (CRD) extends the Kubernetes API. - **Bad example:** A CRD extends the Kubernetes API. +- When referring to a Kubernetes Group (SIG, WG, or UG) do not use the hyphenated + form unless it is for a specific purpose such as a file-name or URI. + - **Good example:** SIG Docs oversees the Kubernetes website. + - **Bad example:** SIG-Docs oversees the Kubernetes website. ### Moving a Document |