Skip to content

We do not include OpenShift CRDs as Style entries#581

Open
aireilly wants to merge 1 commit intoredhat-documentation:mainfrom
aireilly:crd-fix
Open

We do not include OpenShift CRDs as Style entries#581
aireilly wants to merge 1 commit intoredhat-documentation:mainfrom
aireilly:crd-fix

Conversation

@aireilly
Copy link
Copy Markdown
Member

We do not include OpenShift CRDs as Style Guide entries.

rh-pre-commit.version: 2.3.2
rh-pre-commit.check-secrets: ENABLED
@IngridT1
Copy link
Copy Markdown
Collaborator

@aireilly I think we should retain this entry for disambiguation reasons.

@aireilly
Copy link
Copy Markdown
Member Author

@aireilly I think we should retain this entry for disambiguation reasons.

Disambiguation from what though? There are no other OpenShift CRDs in the Style Guide, and this entry even includes the exact same term in the "do not use" section.

@IngridT1
Copy link
Copy Markdown
Collaborator

InferenceService (noun) should remain in the SSG because the entry explicitly says not to use inference serving for the InferenceService CRD. That's the disambiguation that I meant. I think that we can include a CRD if we're having problems with people using a known term incorrectly to refer to it. I think that's why @kelbrown20 included it in the initial PR.

@aireilly
Copy link
Copy Markdown
Member Author

aireilly commented Apr 1, 2026

InferenceService (noun) should remain in the SSG because the entry explicitly says not to use inference serving for the InferenceService CRD. That's the disambiguation that I meant. I think that we can include a CRD if we're having problems with people using a known term incorrectly to refer to it. I think that's why @kelbrown20 included it in the initial PR.

The InferenceService entry treats a Kubernetes CRD (InferenceService) as if it were just a misused generic term. It is not. Inference serving is a general concept, InferenceService is a very specific API resource name.

@IngridT1
Copy link
Copy Markdown
Collaborator

IngridT1 commented Apr 1, 2026

I still don't think it's a problem to include it.

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

Successfully merging this pull request may close these issues.

2 participants