Skip to content

Commit f737cc2

Browse files
authored
Merge pull request #30279 from bergerhoffer/operator-style-exception
Making it clear that Operator is always capitalized
2 parents d6f577a + 2fb3b0c commit f737cc2

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1132,7 +1132,15 @@ For example, the object `kind` for a node is `Node`, not `Nodes`. So do not writ
11321132
====
11331133

11341134
[id="operator-name-capitalization"]
1135-
=== Operator name capitalization
1135+
=== Operator capitalization
1136+
1137+
The term "Operator" is always capitalized. For example:
1138+
1139+
----
1140+
= Support policy for unmanaged Operators
1141+
1142+
Individual Operators have a `managementState` parameter in their configuration.
1143+
----
11361144

11371145
An Operator's full name must be a proper noun, with each word initially
11381146
capitalized. If it includes a product name, defer the product's capitalization

contributing_to_docs/term_glossary.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -426,6 +426,8 @@ application. A Kubernetes application is an application that is both deployed on
426426
a Kubernetes cluster (including OpenShift clusters) and managed using the
427427
Kubernetes APIs and `kubectl` or `oc` tooling.
428428

429+
The term "Operator" is always captalized.
430+
429431
While "containerized" is allowed, do not use "Operatorize" to refer to building an
430432
Operator that packages an application.
431433

0 commit comments

Comments
 (0)