redhat-documentation / supplementary-style-guide

This project maintains the Red Hat supplementary style guide for product documentation that supplements the IBM Style guide
https://redhat-documentation.github.io/supplementary-style-guide/
Creative Commons Attribution Share Alike 4.0 International
36 stars 74 forks source link

hosted control planes replaces HyperShift #518

Open dfitzmau opened 1 month ago

dfitzmau commented 1 month ago

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 commented 1 month ago

@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: