diff --git a/docs/contribute/style-guide.md b/docs/contribute/style-guide.md index 219d62560d..1a23c7fac3 100644 --- a/docs/contribute/style-guide.md +++ b/docs/contribute/style-guide.md @@ -16,15 +16,26 @@ docs, follow the instructions on ## Documentation formatting standards -### Capitalize API objects +### Use Camel Case for API objects -Capitalize the names of API objects. Refer to API objects without saying -"object." +When you refer to an API object, use the same uppercase and lowercase letters +that are used in the actual object name. Typically, the names of API +objects use +[camel case](https://en.wikipedia.org/wiki/Camel_case). + +Don't split the API object name into separate words. For example, use +PodTemplateList, not Pod Template List. + +Refer to API objects without saying "object," unless omitting "object" +leads to an awkward construction.
Do | Don't |
---|---|
The Pod has two Containers. | The pod has two containers. |
The Deployment is responsible for ... | The Deployment object is responsible for ... |
A PodList is a list of Pods. | A Pod List is a list of pods. |
The two ContainerPorts ... | The two ContainerPort objects ... |
The two ContainerStateTerminated objects ... | The two ContainerStateTerminateds ... |