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

Jump to bottom

docs: update information about beta components for v6 #4233

Merged
merged 2 commits into from
Oct 10, 2024
Merged

docs: update information about beta components for v6 #4233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5b325e6
Update README.md
nicolethoen Aug 29, 2024
58b6ae5
Update about-patternfly.md
nicolethoen Aug 29, 2024
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
27 changes: 11 additions & 16 deletions beta-component-promotion/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ initially released in `beta`. Such components are labelled with a blue informati

There are two recommended steps to take when considering using a beta component in product:
1. Play with the component examples in the docs and determine whether or not the current implementation meets your needs. Open issues for any missing features, enhancement requests, or bugs.
2. Check the [PatternFly Issues GitHub Project board](https://github.com/orgs/patternfly/projects/7/views/5) where we have created a view to categorize most issues by component. Browse any open issues for the beta component to determine how much more the beta component could evolve in the near future.
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.

Beta components are open to evolution and possible breaking changes
pending testing and feedback. Each beta component is evaluated on a quarterly basis to evaluate its stability
Expand All @@ -23,21 +23,16 @@ as well as relevant examples in the documentation are all labeled as beta.

| *Component currently in beta* | inital @patternfly/patternfly milestone | inital @patternfly/patternfly-react milestone |
|----------------------------------------|-----------------------------------------|-----------------------------------------------|
| Button: with count | 2022.11 | 2022.12 |
| DataList: draggable | 2021.12 | 2020.13 |
| Drag and drop | 2021.13 | 2021.14 |
Copy link
Contributor

@mcoker mcoker Aug 30, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Drag/drop is still beta on org staging and in core, should take out beta: true in core?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

yes 👍🏻

| Date and time picker demo | -- | 2020.16 |
| Expandable section: truncate expansion | 2022.11 | 2022.11 |
| Label: Editable | 2021.07 | 2021.10 |
| LabelGroup: Editable | 2022.08 | 2022.08 |
| Menu: flyout | 2020.11 | 2021.10 |
| Menu: drilldown | 2020.11 | 2021.03 |
| Nav: flyout | 2021.13 | 2021.13 |
| Nav: drilldown | 2021.12 | -- |
| Pagination: insets | 2022.15 | 2022.16 |
| Spinner: inline | 2022.14 | 2022.15 |
| Chart skeleton theme | -- | 2024 Q2 |
| Table: draggable rows | 2021.08 | 2021.08 |
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we update the table draggable rows examples in core to show the beta badge? https://github.com/patternfly/patternfly/blob/aa31c48cb562da64a2615365141201e021eb1657/src/patternfly/components/Table/examples/Table.md?plain=1#L3769

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We could. They've always been marked beta in react.

| TimePicker | -- | 2020.16 |
| Timestamp | 2022.10 | 2022.11 |
| Select templates | -- | 2024 Q1 |
| Dropdown templates | -- | 2024 Q1 |
| Menu: shouldFocusFirstItemOnOpen | -- | 2024 Q1 |
| Dropdown: shouldFocusFirstItemOnOpen | -- | 2024 Q1 |
| Select: shouldFocusFirstItemOnOpen | -- | 2024 Q1 |
| PageBreadcrumb: hasBodyWrapper | -- | 2024 Q2 |
| PageSection: hasBodyWrapper | -- | 2024 Q2 |
| Pagination: menuAppendTo | -- | 2024 Q2 |
| PaginationOptionsMenu: appendTo | -- | 2024 Q2 |


2 changes: 1 addition & 1 deletion ...ages/documentation-site/patternfly-docs/content/get-started/about-patternfly.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,7 @@ Occasionally, after a component is promoted out of beta, subsequent enhancement
If you are considering using a beta component, make sure to:

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.
1. Check [the PatternFly Issues GitHub Project board](https://github.com/orgs/patternfly/projects/7/views/5) where we have created a view to categorize most issues by component. Browse any open issues for the beta component to determine how much more the beta component could evolve in the near future.
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.


<!-- This section is WIP ** we need to wait to see how this content gets included **
Expand Down
Loading