Skip to content

Commit 826d53c

Browse files
Casie OxfordzacharysarahTim Bannister
authored
Update style guidelines for API object capitalization & formatting (#23497)
* Update style-guide.md updates to api object handling according to SIG email discussion. * Update content/en/docs/contribute/style/style-guide.md Co-authored-by: Zach Corleissen <[email protected]> * Update style-guide.md updating API Object Examples * Update content/en/docs/contribute/style/style-guide.md Co-authored-by: Zach Corleissen <[email protected]> * Update content/en/docs/contribute/style/style-guide.md Co-authored-by: Zach Corleissen <[email protected]> * Update content/en/docs/contribute/style/style-guide.md Co-authored-by: Tim Bannister <[email protected]> Co-authored-by: Zach Corleissen <[email protected]> Co-authored-by: Tim Bannister <[email protected]>
1 parent a67cb90 commit 826d53c

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

content/en/docs/contribute/style/style-guide.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,9 @@ The English-language documentation uses U.S. English spelling and grammar.
4242

4343
## Documentation formatting standards
4444

45-
### Use camel case for API objects
45+
### Use upper camel case for API objects
4646

47-
When you refer to an API object, use the same uppercase and lowercase letters
48-
that are used in the actual object name. Typically, the names of API
49-
objects use
50-
[camel case](https://en.wikipedia.org/wiki/Camel_case).
47+
When you refer specifically to interacting with an API object, use [UpperCamelCase](https://en.wikipedia.org/wiki/Camel_case), also known as Pascal Case. When you are generally discussing an API object, use [sentence-style capitalization](https://docs.microsoft.com/en-us/style-guide/text-formatting/using-type/use-sentence-style-capitalization).
5148

5249
Don't split the API object name into separate words. For example, use
5350
PodTemplateList, not Pod Template List.
@@ -58,9 +55,9 @@ leads to an awkward construction.
5855
{{< table caption = "Do and Don't - API objects" >}}
5956
Do | Don't
6057
:--| :-----
61-
The Pod has two containers. | The pod has two containers.
62-
The Deployment is responsible for ... | The Deployment object is responsible for ...
63-
A PodList is a list of Pods. | A Pod List is a list of pods.
58+
The pod has two containers. | The Pod has two containers.
59+
The HorizontalPodAutoscaler is responsible for ... | The HorizontalPodAutoscaler object is responsible for ...
60+
A PodList is a list of pods. | A Pod List is a list of pods.
6461
The two ContainerPorts ... | The two ContainerPort objects ...
6562
The two ContainerStateTerminated objects ... | The two ContainerStateTerminateds ...
6663
{{< /table >}}
@@ -71,7 +68,7 @@ The two ContainerStateTerminated objects ... | The two ContainerStateTerminateds
7168
Use angle brackets for placeholders. Tell the reader what a placeholder
7269
represents.
7370

74-
1. Display information about a Pod:
71+
1. Display information about a pod:
7572

7673
kubectl describe pod <pod-name> -n <namespace>
7774

@@ -116,15 +113,17 @@ The copy is called a "fork". | The copy is called a "fork."
116113

117114
## Inline code formatting
118115

119-
### Use code style for inline code and commands
116+
### Use code style for inline code, commands, and API objects
120117

121118
For inline code in an HTML document, use the `<code>` tag. In a Markdown
122119
document, use the backtick (`` ` ``).
123120

124121
{{< table caption = "Do and Don't - Use code style for inline code and commands" >}}
125122
Do | Don't
126123
:--| :-----
127-
The `kubectl run`command creates a Pod. | The "kubectl run" command creates a Pod.
124+
The `kubectl run` command creates a `Pod`. | The "kubectl run" command creates a pod.
125+
The kubelet on each node acquires a `Lease`… | The kubelet on each node acquires a lease…
126+
A `PersistentVolume` represents durable storage… | A Persistent Volume represents durable storage…
128127
For declarative management, use `kubectl apply`. | For declarative management, use "kubectl apply".
129128
Enclose code samples with triple backticks. (\`\`\`)| Enclose code samples with any other syntax.
130129
Use single backticks to enclose inline code. For example, `var example = true`. | Use two asterisks (`**`) or an underscore (`_`) to enclose inline code. For example, **var example = true**.
@@ -201,7 +200,7 @@ kubectl get pods | $ kubectl get pods
201200

202201
### Separate commands from output
203202

204-
Verify that the Pod is running on your chosen node:
203+
Verify that the pod is running on your chosen node:
205204

206205
kubectl get pods --output=wide
207206

@@ -513,7 +512,7 @@ Do | Don't
513512
:--| :-----
514513
To create a ReplicaSet, ... | In order to create a ReplicaSet, ...
515514
See the configuration file. | Please see the configuration file.
516-
View the Pods. | With this next command, we'll view the Pods.
515+
View the pods. | With this next command, we'll view the pods.
517516
{{< /table >}}
518517
519518
### Address the reader as "you"
@@ -552,7 +551,7 @@ Do | Don't
552551
:--| :-----
553552
Version 1.4 includes ... | In version 1.4, we have added ...
554553
Kubernetes provides a new feature for ... | We provide a new feature ...
555-
This page teaches you how to use Pods. | In this page, we are going to learn about Pods.
554+
This page teaches you how to use pods. | In this page, we are going to learn about pods.
556555
{{< /table >}}
557556
558557

0 commit comments

Comments
 (0)