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

Update Tech Preview and Dev Preview templates to better emphasize not to use these releases in production environments #512

Open
bburt-rh opened this issue Aug 13, 2024 · 0 comments · May be fixed by #513
Assignees
Labels
Style guideline Topics that add or modify style guidelines

Comments

@bburt-rh
Copy link
Contributor

bburt-rh commented Aug 13, 2024

The Automotive docs team proposes to make the following updates to the Tech Preview and Dev Preview templates in the SSG to emphasize and reinforce that that software released as TP or DP is not intended for production environments. The current wording places this warning in the middle of the text block, and the proposed updates move the warning closer to the beginning for emphasis.

Note that the Automotive docs team management has already gotten approval from Red Hat Legal for these changes.

See #513 to diff the proposed changes with the current wording.

Preview: https://file.rdu.redhat.com/bburt/ssg-512/main.html#support

Current AsciiDoc Dev Preview template:

[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.

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].
====

Proposed AsciiDoc Dev Preview template:

[IMPORTANT]
====
{ProductName} 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. 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].
====

Current AsciiDoc Tech Preview template:

[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.

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].
====

Proposed AsciiDoc Tech Preview template:

[IMPORTANT]
====
{ProductName} is Technology Preview software only. Technology Preview software is not intended for production or business-critical workloads. 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].
====
@bburt-rh bburt-rh added the Style guideline Topics that add or modify style guidelines label Aug 13, 2024
@bburt-rh bburt-rh self-assigned this Aug 13, 2024
@bburt-rh bburt-rh linked a pull request Aug 13, 2024 that will close this issue
@bburt-rh bburt-rh linked a pull request Aug 13, 2024 that will close this issue
@bburt-rh bburt-rh changed the title Update Tech Preview and Dev Preview templates to better emphasize not to use in production environments Update Tech Preview and Dev Preview templates to better emphasize not to use these releases in production environments Aug 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Style guideline Topics that add or modify style guidelines
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant