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.

Sign up for GitHub

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

Issue-512: update-wording-for-tp-dp-templates #513

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −4
Open

Issue-512: update-wording-for-tp-dp-templates #513

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions supplementary_style_guide/style_guidelines/support.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

This software is subject to change or removal at any time, and has received limited testing only.
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.
Red{nbsp}Hat might provide ways to submit feedback on Developer Preview software without an associated SLA.
For more information about the support scope of Red{nbsp}Hat Developer Preview software, see link:https://access.redhat.com/support/offerings/devpreview/[Developer Preview Support Scope].
====
----
Expand Down Expand Up @@ -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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment about these being on individual lines when the preview is built

Technology Preview software is not intended for production or business-critical workloads.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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..."?

Technology Preview software provides early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
Technology Preview features are not supported with Red{nbsp}Hat production service level agreements (SLAs) and might not be functionally complete.
For more information about the support scope of Red{nbsp}Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope].
====
----
Expand Down
Loading