Open
Description
The Kubernetes documentation style-guide encourages the use of UpperCamelCase (also known as PascalCase) when referring to Kubernetes resources.
It's a little nitpicky but I think it would be good to be consistent with this in our own documentation. For example we regularly writer pods
when we should write Pods
.
Examples in our docs
deployment/source/platforms/kubeflow.md
Line 132 in 104ebd3
deployment/source/guides/index.md
Line 57 in d1264c7
Guidance Examples
Guidance form the style-guide
Do | Don't |
---|---|
The HorizontalPodAutoscaler resource is responsible for ... | The Horizontal pod autoscaler is responsible for ... |
A PodList object is a list of pods. | A Pod List object is a list of pods. |
The Volume object contains a hostPath field. | The volume object contains a hostPath field. |
Every ConfigMap object is part of a namespace. | Every configMap object is part of a namespace. |
For managing confidential data, consider using the Secret API. | For managing confidential data, consider using the secret API. |
Metadata
Metadata
Assignees
Labels
No labels