openshift-docs icon indicating copy to clipboard operation
openshift-docs copied to clipboard

[enterprise-4.11] Issue in file operators/operator_sdk/osdk-generating-csvs.adoc

Open adellape opened this issue 3 years ago • 0 comments

Which section(s) is the issue in?

"Enabling Operator conditions"

https://docs.openshift.com/container-platform/4.11/operators/operator_sdk/osdk-generating-csvs.html#osdk-operatorconditions_osdk-generating-csvs

This section first appeared in OCP 4.7, so the change can apply to branches 4.7+.

What needs fixing?

Per IBM Style Guide, lead-in wording to lists should be complete sentences (https://www.ibm.com/docs/en/ibm-style?topic=format-lists#lead-in-wording). There are 2 lists in the "Enabling Operator conditions" section that have lead-in wording that continues into the list items:

To support Operator conditions, an Operator must be able to read the OperatorCondition CR created by OLM and have the ability to:

and

Write your own constructor in your Operator logic that:

These should be converted to complete sentences.

adellape avatar Oct 17 '22 15:10 adellape