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

Drop OpenShiftShort attribute #532

Closed
wants to merge 1 commit into from

Conversation

leifmadsen
Copy link
Member

The documentation style indicates we shouldn't be using OCP or OKD short
forms of OpenShift, so I'm dropping that.

The documentation style indicates we shouldn't be using OCP or OKD short
forms of OpenShift, so I'm dropping that.
@leifmadsen
Copy link
Member Author

So here is a proposal for dropping OpenShiftShort.

Alternatively, could we maybe set the value to OpenShift instead of OCP or something? Right now we always use the long form, which downstream, is really quite long with Red Hat OpenShift Container Platform. I wonder if we should just use OpenShift as the short form?

@mickogeary
Copy link
Collaborator

How about setting the value to RHOCP?

@leifmadsen
Copy link
Member Author

How about setting the value to RHOCP?

I think that defeats the purpose. My understanding is we're not supposed to abbreviate OpenShift at all.

@mickogeary
Copy link
Collaborator

Ok I'll double check with writing team. I can do another commit to #531 that includes the update from this PR (532) if that suits

@leifmadsen
Copy link
Member Author

Ok I'll double check with writing team. I can do another commit to #531 that includes the update from this PR (532) if that suits

We only used OpenShiftShort in 2 spots previously, so I would drop all use of it to maintain consistency in the guide. Since we never used it before, I would recommend it be removed everywhere, and not added in the new disconnected contents.

@mickogeary
Copy link
Collaborator

These changes are incorporated into #531

@mickogeary
Copy link
Collaborator

Do doc-Service-Telemetry-Framework/modules/proc_overriding-a-managed-manifest.adoc and doc-Service-Telemetry-Framework/modules/proc_overriding-a-managed-manifest.adoc get published in the STF guide?

@leifmadsen
Copy link
Member Author

Do doc-Service-Telemetry-Framework/modules/proc_overriding-a-managed-manifest.adoc and doc-Service-Telemetry-Framework/modules/proc_overriding-a-managed-manifest.adoc get published in the STF guide?

Doesn't seem so. I have opened #533 to drop the one file that still exists. Doesn't get included anywhere.

@leifmadsen leifmadsen closed this Mar 1, 2024
@leifmadsen leifmadsen deleted the fixup/drop-openshiftshort-attribute branch March 1, 2024 15:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants