-
Task
-
Resolution: Done
-
Critical
-
Logging 5.2, Logging 5.3, Logging 5.4
-
devex docs #216 Mar 17-Apr 7, devex docs #217 Apr 7-Apr 28
-
8
-
Documentation (Ref Guide, User Guide, etc.)
Name change
New name: logging subsystem for Red Hat OpenShift
Kristin Andrews: "This is a component so our naming standards dictate that we do not capitalize the name, at least the “logging subsystem for” portion. You would still capitalize “Red Hat OpenShift“ because it is a product name. So your formal legally approved
component name is “logging subsystem for Red Hat OpenShift”. The legally approved short name after first use in any copy or other content/documents is “logging subsystem”... it is not typical to provide approved acronyms for components as the names are normally short enough to not warrant them. In this case, with the approved short name of "logging subsystem" that is what should be used in technical documentation as well. You do not have to continue to link it to OpenShift with subsequent mentions in the documents."
Scope of change
Only needs to be changed in OCP 4.9 and 4.10 as those are the versions supported with Logging 5.4.
Shannon Wilber: "Hi Claire, I agree with you that only updating docs for OCP 4.9 and 4.10 would be relevant and not for priors for example 4.7 or 4.8...if Kristin has signed off with an approval on the legal side of things that we are OK changing the legal docs back to Logging versions 5.2 & 5.3 then I approve of this change."
—
Storypoints updated:
- Required the creation of attributes
- The updated name being " logging subsystem for Red Hat OpenShift" made using "find and replace" unusable twice over - grammatically, and by virtue of part of the name also being a concept ('logging'). These factors necessitated a manual review of every file of the documentation.
