Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Check for {product-title} usage #792

Open
bhardesty opened this issue May 23, 2024 · 1 comment
Open

Check for {product-title} usage #792

bhardesty opened this issue May 23, 2024 · 1 comment

Comments

@bhardesty
Copy link

Is your feature request related to a problem? Describe.
The OpenShift docs use the {product-title} attribute extensively, but this occasionally resolves to grammatically-incorrect phrases in certain OpenShift distributions. A common example is this phrase:

an {product-title} cluster

When {product-title} resolves to "OpenShift Container Platform" or "OpenShift Dedicated", this phrase is fine. But when it resolves to "Red Hat OpenShift Service on AWS", the phrase becomes "an Red Hat OpenShift Service on AWS cluster", which is grammatically incorrect.

Describe the solution you'd propose
Warn the user that "an {product-title} cluster" may result in grammatically-incorrect wording if the content appears in the ROSA docs. If the content does appear in the ROSA docs, you should use, "a {product-title} cluster" instead.

Describe alternatives you've considered
At the moment, the only way to check for this issue is to manually look for it during peer reviews.

One alternative would be to create a couple new attributes for this particular phrase. For example:

:ocp-osd-cluster-lower: an {product-title} cluster
:ocp-osd-cluster-upper: An {product-title} cluster
:rosa-cluster-lower: a {product-title} cluster
:rosa-cluster-upper: A {product-title} cluster

However, this does get a bit awkward to apply, and gets really tricky if we need to account for additional distributions (ARO, Microshift, etc.).

@apinnick
Copy link
Collaborator

I ran into a similar situation with KubeVirt vs OpenShift Virtualization.

I created upstream and downstream attributes:

:KubeVirt: KubeVirt
:a-KubeVirt: a KubeVirt

:KubeVirt: OpenShift Virtualization
:a-KubeVirt: an OpenShift Virtualization

I did not need an upper-case "A", only lower case.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants