Skip to content

Emphasize production warnings in Tech Preview and Dev Preview templates - #602

Open
lburcher7 wants to merge 1 commit into
redhat-documentation:mainfrom
lburcher7:update-preview-templates-512-clean
Open

lburcher7 wants to merge 1 commit into
redhat-documentation:mainfrom
lburcher7:update-preview-templates-512-clean

Conversation

@lburcher7

Copy link
Copy Markdown
Contributor

Move the "not intended for production or business-critical workloads" warning to the beginning of both template admonitions for better visibility.

Changes:

  • Developer Preview: Lead with production warning, remove redundant "Do not use" and "production-ready" language
  • Technology Preview: Add explicit production warning early, remove vague "does not recommend using them in production" text

These changes align with legal requirements to make the production restrictions more prominent and clear.

Issue: #512

Move the "not intended for production or business-critical workloads"
warning to the beginning of both template admonitions for better visibility.

Changes:
- Developer Preview: Lead with production warning, remove redundant "Do not use"
  and "production-ready" language
- Technology Preview: Add explicit production warning early, remove vague
  "does not recommend using them in production" text

These changes align with legal requirements to make the production restrictions
more prominent and clear.

Fixes redhat-documentation#512

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Sep 28, 2026 •

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: b147b3e4-0ef0-4e9d-adb9-eee28d47840b

📥 Commits

Reviewing files that changed from the base of the PR and between e1580e5 and ca18fb9.

📒 Files selected for processing (1)
  • supplementary_style_guide/style_guidelines/support.adoc

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated the Developer Preview notice to combine the production-use warning with the statement that the software is unsupported and may be incomplete.
    • Updated the Technology Preview notice to state that features are not intended for production or business-critical workloads, replacing the previous recommendation against production use.

Walkthrough

The Developer Preview and Technology Preview templates now use revised statements about production and business-critical workloads.

Changes

Preview support statements

Layer / File(s) Summary
Update preview template wording
supplementary_style_guide/style_guidelines/support.adoc
The Developer Preview template combines the production-use warning with the statement that the software is unsupported and may be incomplete. The Technology Preview template says its features are not intended for production or business-critical workloads. It removes the prior recommendation against production use.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to ca18f

The updated warnings follow the repository’s preview templates. No concrete merge-blocking issue is established, though the linked issue’s legal rationale could not be independently checked.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: making production warnings more prominent in the Technology Preview and Developer Preview templates.
Description check ✅ Passed The description explains the changes, provides context, states the legal objective, and includes the issue link. The optional Additional information section is not required.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

Comment @coderabbitai help to get the list of available commands.

@IngridT1

Copy link
Copy Markdown
Collaborator

Legal is currently reworking the Developer Preview language. When it's ready, we can replace the current Developer Preview warning with the new language.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants