Skip to content

Commit 764cabd

Browse files
authored
Merge pull request #54412 from bergerhoffer/operator-capitalization-update
Adding difference in Operator capitalization for marketing vs technic…
2 parents 08d64b8 + d18e381 commit 764cabd

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1829,6 +1829,15 @@ style guidelines. For example:
18291829
- Node Tuning Operator
18301830
- Cluster Version Operator
18311831

1832+
[NOTE]
1833+
====
1834+
Red Hat Brand and Legal guidance for Operator names will likely differ. For marketing materials, they prefer lowercase names for anything that is not a Red Hat product.
1835+
1836+
However, the Brand team recognizes that there are different standards for marketing materials versus technical content. For this reason, the title case capitalization for Operator names in technical product documentation and OperatorHub is acceptable.
1837+
1838+
The "Naming" page by Red Hat Brand on the Source provides an overview of naming slide deck that also confirms this difference.
1839+
====
1840+
18321841
== Declarative config examples
18331842

18341843
Many of our procedures provide imperative `oc` commands (which cannot be stored in a Git repo). Due to efforts around improving the experience for GitOps users, we sometimes also want to provide a declarative YAML example that achieves the same configuration. This allows users to store these YAML configurations in a Git repo and follow GitOps practices to configure OpenShift.

0 commit comments

Comments
 (0)