Skip to content

Commit 37290ad

Browse files
nicolethoenevwilkin
nicolethoen
and
evwilkin
authored
docs: add latest changes to release notes and add a few extra note to upgrade guide (#3640)
* docs: add latest changes to release notes and add a few extra note to upgrade guide * update per comments * update per PR comments * Uppercase select in deprecated table list Co-authored-by: Evan <evan.wilkinson@gmail.com> --------- Co-authored-by: Evan <evan.wilkinson@gmail.com> Co-authored-by: Evan <evan.wilkinson@redhat.com>
1 parent 7df79d5 commit 37290ad

File tree

4 files changed

+189
-85
lines changed

4 files changed

+189
-85
lines changed

‎packages/documentation-site/patternfly-docs/content/get-started/release-highlights.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -125,16 +125,16 @@ As PatternFly has matured, a number of its popular components have been repeated
125125

126126
The following table outlines the components that are affected, as well as the component(s) that we recommend using as a replacement.
127127

128-
| Deprecated component | Recommended replacement |
129-
|---------------------------------------------------------------------------------|----------------------------------------------------------------------------|
130-
| [Application launcher](/components/menus/application-launcher/react-deprecated) | [Dropdown](/components/menus/dropdown), [select](/components/menus/select) |
131-
| [Context selector](/components/menus/context-selector/react-deprecated) | [Menu](/components/menus/menu) |
132-
| [Dropdown (deprecated)](/components/menus/dropdown/react-deprecated) | [Dropdown](/components/menus/dropdown) |
133-
| [Options menu](/components/menus/options-menu/react-deprecated) | [Dropdown](/components/menus/dropdown), [select](/components/menus/select) |
134-
| [Page header](/components/page/react-deprecated) | [Masthead](/components/masthead) |
135-
| [Select (deprecated)](/components/menus/select/react-deprecated) | [Select](/components/menus/select) |
136-
| [Table (deprecated)](/components/table/react-deprecated) | [Table](/components/table) |
137-
| [Wizard (deprecated)](/components/wizard/react-deprecated) | [Wizard](/components/wizard) |
128+
| Deprecated component | Recommended replacement |
129+
|---------------------------------------------------------------------------------|----------------------------------------|
130+
| [Application launcher](/components/menus/application-launcher/react-deprecated) | [Dropdown](/components/menus/dropdown) |
131+
| [Context selector](/components/menus/context-selector/react-deprecated) | [Dropdown](/components/menus/dropdown) |
132+
| [Dropdown (deprecated)](/components/menus/dropdown/react-deprecated) | [Dropdown](/components/menus/dropdown) |
133+
| [Options menu](/components/menus/options-menu/react-deprecated) | [Select](/components/menus/select) |
134+
| [Page header](/components/page/react-deprecated) | [Masthead](/components/masthead) |
135+
| [Select (deprecated)](/components/menus/select/react-deprecated) | [Select](/components/menus/select) |
136+
| [Table (deprecated)](/components/table/react-deprecated) | [Table](/components/table) |
137+
| [Wizard (deprecated)](/components/wizard/react-deprecated) | [Wizard](/components/wizard) |
138138

139139
**Note:** To understand how our new composable menus can be used to replace deprecated components, [view our custom menus examples](/components/menus/custom-menus).
140140

‎packages/documentation-site/patternfly-docs/content/get-started/release-notes-data.js‎

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4941,4 +4941,158 @@ import { Wizard } from '@patternfly/react-core/deprecated';`}
49414941
repo: "react-user-feedback",
49424942
fixedWithCodeMod: false
49434943
},
4944+
{
4945+
component: "Form control",
4946+
description: "Changed all the divs in a form control to be spans to allow a form control to be inside phrasing content.",
4947+
pullRequestURL: "https://github.com/patternfly/patternfly/pull/5703",
4948+
repo: "HTML/CSS",
4949+
fixedWithCodeMod: false
4950+
},
4951+
{
4952+
component: "Select",
4953+
description: "Fixed typeahead form control border styles.",
4954+
pullRequestURL: "https://github.com/patternfly/patternfly/pull/5698",
4955+
repo: "HTML/CSS",
4956+
fixedWithCodeMod: false
4957+
},
4958+
{
4959+
component: "Charts",
4960+
description: (<>Fixed dark theme chart var prefix from <code className='ws-code'>pf-v5-c-chart</code> to <code className='ws-code'>pf-v5-chart</code>.</>),
4961+
pullRequestURL: "https://github.com/patternfly/patternfly/pull/5673",
4962+
repo: "HTML/CSS",
4963+
fixedWithCodeMod: false
4964+
},
4965+
{
4966+
component: "Fonts",
4967+
description: "Fixed incorrect font mapping from bold to italic for RHD font.",
4968+
pullRequestURL: "https://github.com/patternfly/patternfly/pull/5678",
4969+
repo: "HTML/CSS",
4970+
fixedWithCodeMod: false
4971+
},
4972+
{
4973+
component: "Text input group",
4974+
description: "Addressed the cause of the search input icon and placeholder text being the wrong color when in a masthead or dark block.",
4975+
pullRequestURL: "https://github.com/patternfly/patternfly/pull/5666",
4976+
repo: "HTML/CSS",
4977+
fixedWithCodeMod: false
4978+
},
4979+
{
4980+
component: "Card",
4981+
description: "Fixed how the newly introduced selectable cards are fixed in light theme.",
4982+
pullRequestURL: "https://github.com/patternfly/patternfly/pull/5668",
4983+
repo: "HTML/CSS",
4984+
fixedWithCodeMod: false
4985+
},
4986+
{
4987+
component: "Button",
4988+
description: <>Re-introduced a CSS var override in the button's <code className='ws-code'>pf-t-dark</code> placeholder that sets the primary button background.</>,
4989+
pullRequestURL: "https://github.com/patternfly/patternfly/pull/5652",
4990+
repo: "HTML/CSS",
4991+
fixedWithCodeMod: false
4992+
},
4993+
{
4994+
component: "@All",
4995+
description: "Prefixed and relocated variable font opt-in.",
4996+
pullRequestURL: "https://github.com/patternfly/patternfly/pull/5617",
4997+
repo: "HTML/CSS",
4998+
fixedWithCodeMod: false
4999+
},
5000+
{
5001+
component: "Menu toggle",
5002+
description: "Removed the background from full height menu toggles in dark theme.",
5003+
pullRequestURL: "https://github.com/patternfly/patternfly/pull/5643",
5004+
repo: "HTML/CSS",
5005+
fixedWithCodeMod: false
5006+
},
5007+
{
5008+
component: "Calendar month",
5009+
description: "Updated background color of calendar month date ranges.",
5010+
pullRequestURL: "https://github.com/patternfly/patternfly/pull/5624",
5011+
repo: "HTML/CSS",
5012+
fixedWithCodeMod: false
5013+
},
5014+
{
5015+
component: "OUIA",
5016+
description: (<>Updated the OUIA <code className='ws-code'>data-ouia-component-type</code> prefix from <code className='ws-code'>PF4</code> to <code className='ws-code'>PF5</code>.</>),
5017+
pullRequestURL: "https://github.com/patternfly/patternfly-react/pull/9250",
5018+
repo: "React",
5019+
fixedWithCodeMod: false
5020+
},
5021+
{
5022+
component: "Popover",
5023+
description: (<>Reverted default value of popover <code className='ws-code'>appendTo</code> prop so it is now <code className='ws-code'>() => document.body</code>.</>),
5024+
pullRequestURL: "https://github.com/patternfly/patternfly-react/pull/9252",
5025+
repo: "React",
5026+
fixedWithCodeMod: false
5027+
},
5028+
{
5029+
component: "Toolbar",
5030+
description: (<>Updated <code className='ws-code'>alignItems</code> and <code className='ws-code'>alignSelf</code> on <code className='ws-code'>ToolbarContent</code>, <code className='ws-code'>ToolbarGroup</code> and <code className='ws-code'>ToolbarItem</code> to have values <code className='ws-code'>start</code>, <code className='ws-code'>center</code>, and <code className='ws-code'>baseline</code>.</>),
5031+
pullRequestURL: "https://github.com/patternfly/patternfly-react/pull/9325",
5032+
repo: "React",
5033+
fixedWithCodeMod: false
5034+
},
5035+
{
5036+
component: "Text input",
5037+
description: (<>Changed divs in form control elements to spans.</>),
5038+
pullRequestURL: "https://github.com/patternfly/patternfly-react/pull/9334",
5039+
repo: "React",
5040+
fixedWithCodeMod: false
5041+
},
5042+
{
5043+
component: "Text area",
5044+
description: (<>Changed divs in form control elements to spans.</>),
5045+
pullRequestURL: "https://github.com/patternfly/patternfly-react/pull/9334",
5046+
repo: "React",
5047+
fixedWithCodeMod: false
5048+
},
5049+
{
5050+
component: "Form select",
5051+
description: (<>Changed divs in form control elements to spans.</>),
5052+
pullRequestURL: "https://github.com/patternfly/patternfly-react/pull/9334",
5053+
repo: "React",
5054+
fixedWithCodeMod: false
5055+
},
5056+
{
5057+
component: "Charts",
5058+
description: (<>Exported <code className='ws-code'>getThemeColors</code>.</>),
5059+
pullRequestURL: "https://github.com/patternfly/patternfly-react/pull/9338",
5060+
repo: "React",
5061+
fixedWithCodeMod: false
5062+
},
5063+
{
5064+
component: "Select",
5065+
description: (<>Used text input component in the typeahead toggle for the deprecated select.</>),
5066+
pullRequestURL: "https://github.com/patternfly/patternfly-react/pull/9317",
5067+
repo: "React",
5068+
fixedWithCodeMod: false
5069+
},
5070+
{
5071+
component: "Select",
5072+
description: (<>Used text input component in the typeahead toggle for the deprecated select.</>),
5073+
pullRequestURL: "https://github.com/patternfly/patternfly-react/pull/9317",
5074+
repo: "React",
5075+
fixedWithCodeMod: false
5076+
},
5077+
{
5078+
component: "@All",
5079+
description: (<>Created component level package.json files to enable federated modules.</>),
5080+
pullRequestURL: ["https://github.com/patternfly/patternfly-react/pull/9287","https://github.com/patternfly/patternfly-react/pull/9260", "https://github.com/patternfly/patternfly-react/pull/9272"],
5081+
repo: "React",
5082+
fixedWithCodeMod: false
5083+
},
5084+
{
5085+
component: "Charts",
5086+
description: (<>Updated Victory packages to the latest version (36.6.11).</>),
5087+
pullRequestURL: "https://github.com/patternfly/patternfly-react/pull/9276",
5088+
repo: "React",
5089+
fixedWithCodeMod: false
5090+
},
5091+
{
5092+
component: "Icons",
5093+
description: (<>Added fallback width and height attributes to icons from @patternfly/react-icons.</>),
5094+
pullRequestURL: "https://github.com/patternfly/patternfly-react/pull/9257",
5095+
repo: "React",
5096+
fixedWithCodeMod: false
5097+
}
49445098
];

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

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,3 +92,28 @@ PatternFly 5 brings a new implementation to the following components, which can
9292
- [Select](/components/menus/select)
9393
- [Dropdown ](/components/menus/dropdown)
9494
- [Wizard](/components/wizard)
95+
96+
## Other notes
97+
98+
As you upgrade to PatternFly 5, keep in mind the following considerations:
99+
100+
101+
When updating the react-topology package, note that the topology styles have been removed from their previous home in @patternfly/react-styles and now need to be imported directly from [react-topology.](https://github.com/patternfly/react-topology)
102+
103+
<div class="ws-content-table">
104+
105+
| **Before** | **After** |
106+
|-----------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|
107+
| `import styles from '@patternfly/react-styles/css/components/Topology/topology-components';` | `import styles from '@patternfly/react-topology/dist/js/css/topology-components';` |
108+
109+
</div>
110+
111+
In general, though PatternFly ships a `src` directory in it's npm package, it is not advised to import components from a `src` directory. Instead, when importing via absolute paths, import components from `dist` directories.
112+
113+
<div class="ws-content-table">
114+
115+
| **Before** | **After** |
116+
|-----------------------------------------------------------------|---------------------------------------------------------------------|
117+
| `import { Node } from '@patternfly/react-topology/src/types';` | `import { Node } from '@patternfly/react-topology/dist/esm/types';` |
118+
119+
</div>

‎yarn.lock‎

Lines changed: 0 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -2471,81 +2471,6 @@
24712471
acorn-static-class-features "^1.0.0"
24722472
astring "^1.7.5"
24732473

2474-
"@patternfly/documentation-framework@2.0.0-alpha.66":
2475-
version "2.0.0-alpha.66"
2476-
resolved "https://registry.yarnpkg.com/@patternfly/documentation-framework/-/documentation-framework-2.0.0-alpha.66.tgz#506c68e537a0588883475e2ccffb57949663aef2"
2477-
integrity sha512-AO1y38RkqU1n3q/185JhZMtaqyARzCjJlvERK6DFn4xdoKOhPE57+EFvmY+RrvY/7tQJ1DO8CQXMu9ttvpZPKQ==
2478-
dependencies:
2479-
"@babel/core" "7.18.2"
2480-
"@babel/plugin-proposal-class-properties" "7.17.12"
2481-
"@babel/plugin-proposal-optional-chaining" "^7.18.9"
2482-
"@babel/plugin-proposal-private-methods" "7.17.12"
2483-
"@babel/plugin-proposal-private-property-in-object" "7.17.12"
2484-
"@babel/plugin-transform-react-jsx" "7.17.12"
2485-
"@babel/preset-env" "7.18.2"
2486-
"@mdx-js/util" "1.6.16"
2487-
"@patternfly/ast-helpers" "^0.4.57"
2488-
"@reach/router" "npm:@gatsbyjs/reach-router@1.3.9"
2489-
autoprefixer "9.8.6"
2490-
babel-loader "9.1.2"
2491-
camelcase-css "2.0.1"
2492-
chokidar "3.5.3"
2493-
clean-webpack-plugin "4.0.0"
2494-
codesandbox "2.2.0"
2495-
commander "4.1.1"
2496-
copy-webpack-plugin "11.0.0"
2497-
css-loader "6.7.3"
2498-
detab "2.0.3"
2499-
express "4.18.1"
2500-
file-loader "6.2.0"
2501-
file-saver "1.3.8"
2502-
fs-extra "9.0.1"
2503-
glob "8.0.3"
2504-
handlebars "4.7.7"
2505-
hast-to-hyperscript "9.0.0"
2506-
hast-util-to-text "2.0.0"
2507-
html-formatter "0.1.9"
2508-
html-webpack-plugin "5.5.0"
2509-
js-yaml "3.14.0"
2510-
mdast-util-to-hast "9.1.1"
2511-
mdurl "1.0.1"
2512-
mini-css-extract-plugin "2.7.5"
2513-
monaco-editor "0.34.1"
2514-
monaco-editor-webpack-plugin "7.0.1"
2515-
null-loader "4.0.1"
2516-
parse-entities "2.0.0"
2517-
path-browserify "1.0.1"
2518-
postcss "7.0.32"
2519-
postcss-loader "7.1.0"
2520-
process "^0.11.10"
2521-
puppeteer "14.3.0"
2522-
puppeteer-cluster "0.23.0"
2523-
react-docgen "5.3.1"
2524-
react-monaco-editor "^0.51.0"
2525-
react-ssr-prepass "1.5.0"
2526-
remark-footnotes "1.0.0"
2527-
remark-frontmatter "2.0.0"
2528-
remark-mdx "2.0.0-next.8"
2529-
remark-mdxjs "2.0.0-next.8"
2530-
remark-parse "8.0.3"
2531-
remark-squeeze-paragraphs "4.0.0"
2532-
responsive-loader "3.1.2"
2533-
sharp "0.30.6"
2534-
style-to-object "0.3.0"
2535-
to-vfile "6.1.0"
2536-
typedoc "0.22.X"
2537-
typescript "4.3.5"
2538-
unified "9.1.0"
2539-
unist-util-remove "2.0.0"
2540-
unist-util-visit "2.0.3"
2541-
url-loader "4.1.0"
2542-
vfile-reporter "6.0.1"
2543-
webpack "5.76.3"
2544-
webpack-bundle-analyzer "4.8.0"
2545-
webpack-cli "5.0.1"
2546-
webpack-dev-server "4.13.1"
2547-
webpack-merge "5.8.0"
2548-
25492474
"@patternfly/patternfly-a11y@4.3.1":
25502475
version "4.3.1"
25512476
resolved "https://registry.yarnpkg.com/@patternfly/patternfly-a11y/-/patternfly-a11y-4.3.1.tgz#09f050d3a899a60471519f552d64ecaaeb5fec2f"

0 commit comments

Comments
 (0)