Issue-512: update-wording-for-tp-dp-templates #513
Conversation
| @@ -33,8 +33,10 @@ Use the following template. Replace _<software_name>_ with the software name: | |||
| ---- | |||
| [IMPORTANT] | |||
| ==== | |||
| _<software_name>_ is Developer Preview software only. Developer Preview software is not supported by Red{nbsp}Hat in any way and is not functionally complete or production-ready. Do not use Developer Preview software for production or business-critical workloads. Developer Preview software provides early access to upcoming product software in advance of its possible inclusion in a Red{nbsp}Hat product offering. Customers can use this software to test functionality and provide feedback during the development process. This software might not have any documentation, is subject to change or removal at any time, and has received limited testing. Red{nbsp}Hat might provide ways to submit feedback on Developer Preview software without an associated SLA. | |||
|
|
|||
| _<software_name>_ is Developer Preview software only, and as such, it is not intended for production or business-critical workloads. Developer Preview software is not supported by Red{nbsp}Hat in any way and is not functionally complete. | |||
There was a problem hiding this comment.
Right now, this is rendering as each of these lines on separate lines (unlike normal paragraphs where this would have been smushed together).
So if it's supposed to be a single block paragraph, then you likely need to put these all on the same line.
But also should consider whether there should be any blank lines between them. At the very least, there should likely be a blank line before "For more information about..." to match how it was in the previous snippet text. But I think it might be a good time to decide whether any additional breaks could help readability
| @@ -68,8 +70,10 @@ Use the following template text verbatim, where _<feature_name>_ is your feature | |||
| ---- | |||
| [IMPORTANT] | |||
| ==== | |||
| _<feature_name>_ is a Technology Preview feature only. Technology Preview features are not supported with Red{nbsp}Hat production service level agreements (SLAs) and might not be functionally complete. Red{nbsp}Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. | |||
|
|
|||
| _<feature_name>_ is a Technology Preview feature only. | |||
There was a problem hiding this comment.
Same comment about these being on individual lines when the preview is built
| _<feature_name>_ is a Technology Preview feature only. Technology Preview features are not supported with Red{nbsp}Hat production service level agreements (SLAs) and might not be functionally complete. Red{nbsp}Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. | ||
|
|
||
| _<feature_name>_ is a Technology Preview feature only. | ||
| Technology Preview software is not intended for production or business-critical workloads. |
There was a problem hiding this comment.
I don't think we previously referred to it as "Technology Preview software". Just "Technology Preview features". Is that a purposeful change? If not, could we change it to say "Technology Preview features..."?
bergerhoffer
added
Style guideline
|
Hi @bburt-rh. It looks like this is close to being completed. Are you able to address Andrea's suggestions? If so, we can then review and approve :) |
|
Did not have time at the 28 August SSG meeting to discuss this, due to the SSG stop activities announcement |
Preview: https://file.rdu.redhat.com/bburt/ssg-512/main.html#support
Issue: #512
Additional information:
Updates the tech preview and dev preview templates to emphasize more clearly that these software releases are not intended for production environments.