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

hosted control planes replaces HyperShift #518

Open
dfitzmau opened this issue Oct 3, 2024 · 1 comment
Open

hosted control planes replaces HyperShift #518

dfitzmau opened this issue Oct 3, 2024 · 1 comment

Comments

@dfitzmau
Copy link
Contributor

dfitzmau commented Oct 3, 2024

https://issues.redhat.com/browse/OCPBUGS-41971 highlights the confusion around the terms "hosted control planes" and HyperShift. The term hosted control planes has replaced HyperShift. Previous OCP release note docs highlight both terms in a confusing manner. To make things further complicated, the "HyperShift Operator" is the correct name for this Operator.

I think adding an index item to the RH SSG for these terms would help alleviate any confusion, including if "hosted control planes" is lowercase of upper case.

If this issue gets the A-OK, I'll contact Laura Hinson and Matt Werner to clarify numerous terminology around these components.

@lahinson
Copy link
Contributor

lahinson commented Oct 8, 2024

@dfitzmau Thanks for opening this issue. I think it would be helpful to add guidance for "hosted control planes" to the SSG. Here's some guidance that might be helpful to include in an entry:

  • HyperShift is the internal name for what is officially known as hosted control planes.
  • The term HyperShift is used in customer-facing content only in reference to the HyperShift Operator.
  • In any customer-facing content, we refer to HyperShift as “hosted control planes for OpenShift Container Platform” (first reference) or “hosted control planes” (subsequent references).
  • Capitalize the “h” in “hosted control planes” only when “hosted” is the first word in a title, heading, or sentence.
  • In the documentation for hosted control planes with ROSA, the writers are allowed to use “HCP with ROSA”, per branding.

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