You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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).
51
48
52
49
Don't split the API object name into separate words. For example, use
53
50
PodTemplateList, not Pod Template List.
@@ -58,9 +55,9 @@ leads to an awkward construction.
58
55
{{< table caption = "Do and Don't - API objects" >}}
59
56
Do | Don't
60
57
:--| :-----
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.
64
61
The two ContainerPorts ... | The two ContainerPort objects ...
65
62
The two ContainerStateTerminated objects ... | The two ContainerStateTerminateds ...
66
63
{{< /table >}}
@@ -71,7 +68,7 @@ The two ContainerStateTerminated objects ... | The two ContainerStateTerminateds
71
68
Use angle brackets for placeholders. Tell the reader what a placeholder
72
69
represents.
73
70
74
-
1. Display information about a Pod:
71
+
1. Display information about a pod:
75
72
76
73
kubectl describe pod <pod-name> -n <namespace>
77
74
@@ -116,15 +113,17 @@ The copy is called a "fork". | The copy is called a "fork."
116
113
117
114
## Inline code formatting
118
115
119
-
### Use code style for inline codeand commands
116
+
### Use code style for inline code, commands, and API objects
120
117
121
118
For inline code in an HTML document, use the `<code>` tag. In a Markdown
122
119
document, use the backtick (`` ` ``).
123
120
124
121
{{< table caption = "Do and Don't - Use code style for inline code and commands" >}}
125
122
Do | Don't
126
123
:--| :-----
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…
128
127
For declarative management, use `kubectl apply`. | For declarative management, use "kubectl apply".
129
128
Enclose code samples with triple backticks. (\`\`\`)| Enclose code samples with any other syntax.
130
129
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
201
200
202
201
### Separate commands from output
203
202
204
-
Verify that the Pod is running on your chosen node:
203
+
Verify that the pod is running on your chosen node:
205
204
206
205
kubectl get pods --output=wide
207
206
@@ -513,7 +512,7 @@ Do | Don't
513
512
:--| :-----
514
513
To create a ReplicaSet, ... | In order to create a ReplicaSet, ...
515
514
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.
517
516
{{< /table >}}
518
517
519
518
### Address the reader as "you"
@@ -552,7 +551,7 @@ Do | Don't
552
551
:--| :-----
553
552
Version 1.4 includes ... | In version 1.4, we have added ...
554
553
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.
0 commit comments