Skip to content

Commit 242425d

Browse files
authored
docs(about-patternfly): Updates description of beta features. (#4772)
1 parent 683bdaf commit 242425d

File tree

3 files changed

+37
-10
lines changed

3 files changed

+37
-10
lines changed

packages/documentation-site/patternfly-docs/content/get-started/about-patternfly.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -136,20 +136,17 @@ A major version of PatternFly will only be supported through the subsequent vers
136136

137137
Minor feature releases will be available quarterly to introduce non-breaking changes, like new features and enhancements. We will also share interim patch releases to fix any bugs that we find.
138138

139-
### Beta components
139+
### Beta features
140140

141-
New PatternFly components are first released in beta. To help you identify beta components, we add a blue label beside the component in the PatternFly.org navigation menu and an informational alert at the top of the component’s documentation pages.
141+
Significant changes to our components and design tokens are first released in beta. You can identify these features by the blue "beta" label in our site's navigation or in an alert within related documentation. Beta features are subject to change based on user feedback and are only promoted to fully-supported status once they are stable and thoroughly tested.
142142

143-
Beta components continue to evolve as users share feedback. As these components are tested, they are subject to breaking changes, which are changes that affect visuals, applied CSS class names, or existing React properties (including the addition of new properties). We review beta components every quarter to evaluate their stability and the degree to which they meet product requirements. Once a component is stable, it's proposed as a promotion candidate. Once promoted, breaking changes are not made to components outside of a well-advertised breaking change release.
143+
<div class="ws-docs-content-img">
144+
![Blue, pill-shaped label that says "Beta", with a black text bubble beside the label.](./img/beta-tooltip.svg)
145+
</div>
144146

145-
Occasionally, after a component is promoted out of beta, subsequent enhancement requests require the introduction of new CSS class names and React properties. Whenever these enhancements are substantial enough to lead to further component updates (pending testing and feedback), then a beta label is applied to the new class names and properties, as well as relevant examples in the component’s documentation.
147+
The API, visuals, or underlying code for a beta feature can receive breaking changes as we gather feedback. This includes changes to a component's CSS class names or React properties, as well as changes to specific token values for a visual theme. Once a feature is promoted out of beta, we will not make further breaking changes outside of a planned major release.
146148

147-
[Learn more about beta components and view a list of current promotion candidates here.](https://github.com/patternfly/patternfly-org/tree/main/beta-component-promotion)
148-
149-
If you are considering using a beta component, make sure to:
150-
151-
1. Play with the examples in the component's documentation on the PatternFly website to determine if the current implementation meets your needs. Open issues for any missing features, enhancement requests, or bugs.
152-
2. Check the [PatternFly Issues GitHub Project board](https://github.com/orgs/patternfly/projects/7/views/1). Browse any open issues for the beta component to determine how much more the beta component could evolve in the near future.
149+
Before using a beta feature, we recommend reading its documentation and experimenting with the provided examples to ensure it meets your needs. You can track the development status and potential future changes for all beta features on the [PatternFly GitHub project board](https://github.com/orgs/patternfly/projects/7/views/1). For more specific information on the component promotion process, you can also refer to this [beta component promotion README](https://github.com/patternfly/patternfly-org/tree/main/beta-component-promotion).
153150

154151
### Deprecated components
155152

@@ -159,7 +156,9 @@ Occasionally, a component page will contain a "React next" tab, which contains d
159156

160157
Deprecated components will typically be available to use until the next major release, after which no documentation will be included on the current release website.
161158

159+
<div class="ws-docs-content-img">
162160
![Onsite deprecated component messages](./img/deprecated-component.png)
161+
</div>
163162

164163
Deprecation includes:
165164

packages/documentation-site/patternfly-docs/content/get-started/get-started.css

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,10 @@
1010
#supported-browsers.ws-title + table {
1111
margin-bottom: 16px;
1212
}
13+
14+
.ws-docs-content-img {
15+
text-align: center;
16+
margin-inline: auto;
17+
width: 100%;
18+
max-width: 700px;
19+
}

packages/documentation-site/patternfly-docs/content/get-started/img/beta-tooltip.svg

Lines changed: 21 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)