@patternfly/documentation-framework 6.0.0-alpha.20 → 6.0.0-alpha.22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +279 -0
- package/app.js +1 -3
- package/components/cssVariables/cssVariables.js +1 -1
- package/components/sideNav/sideNav.js +1 -1
- package/layouts/sideNavLayout/sideNavLayout.js +17 -0
- package/package.json +7 -11
- package/scripts/webpack/webpack.base.config.js +6 -14
- package/templates/mdx.css +1 -0
- package/templates/mdx.js +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,285 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
# 6.0.0-alpha.22 (2024-04-23)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Bug Fixes
|
|
10
|
+
|
|
11
|
+
* **docs:** Add tokens back to site ([#3978](https://github.com/patternfly/patternfly-org/issues/3978)) ([1c97da8](https://github.com/patternfly/patternfly-org/commit/1c97da8b92d3fe331e49395c26730c5f4bc3b5e3))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
# 6.0.0-alpha.21 (2024-04-17)
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
### Bug Fixes
|
|
21
|
+
|
|
22
|
+
* **docs:** whitspace change ([#3966](https://github.com/patternfly/patternfly-org/issues/3966)) ([2199dc8](https://github.com/patternfly/patternfly-org/commit/2199dc883e6d118d6bedfa9d6ced3cefad78c575))
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
# 5.10.0 (2024-04-02)
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
### Features
|
|
32
|
+
|
|
33
|
+
* **Templates:** add to org site ([#3947](https://github.com/patternfly/patternfly-org/issues/3947)) ([a869dee](https://github.com/patternfly/patternfly-org/commit/a869dee87cc39296df9226f3fc1d780dce893a54))
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
## 5.9.1 (2024-04-02)
|
|
40
|
+
|
|
41
|
+
**Note:** Version bump only for package @patternfly/documentation-framework
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
# 5.9.0 (2024-04-02)
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
### Features
|
|
51
|
+
|
|
52
|
+
* **docs:** update medium articles ([#3950](https://github.com/patternfly/patternfly-org/issues/3950)) ([5288ec1](https://github.com/patternfly/patternfly-org/commit/5288ec1fb1f7e744ed142585384840c8d415d9e5))
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
## 5.8.3 (2024-03-28)
|
|
59
|
+
|
|
60
|
+
**Note:** Version bump only for package @patternfly/documentation-framework
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
## 5.8.2 (2024-03-25)
|
|
67
|
+
|
|
68
|
+
**Note:** Version bump only for package @patternfly/documentation-framework
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
## 5.8.1 (2024-03-25)
|
|
75
|
+
|
|
76
|
+
**Note:** Version bump only for package @patternfly/documentation-framework
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
# 5.8.0 (2024-03-20)
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
### Features
|
|
86
|
+
|
|
87
|
+
* **templates:** add templates package to versions.json ([#3902](https://github.com/patternfly/patternfly-org/issues/3902)) ([c7c727c](https://github.com/patternfly/patternfly-org/commit/c7c727c717d5cc3c031f4f3c52070ffc6164e5d6))
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
# 5.7.0 (2024-03-19)
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
### Features
|
|
97
|
+
|
|
98
|
+
* add pf 6 alpha banner to home page and version switcher ([#3896](https://github.com/patternfly/patternfly-org/issues/3896)) ([f7aaa22](https://github.com/patternfly/patternfly-org/commit/f7aaa22d12310aa62533de4169e1fa70a49a20d9))
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
# 5.6.0 (2024-03-13)
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
### Features
|
|
108
|
+
|
|
109
|
+
* **deps:** version bump and release notes for 5.2.2 patch release ([#3919](https://github.com/patternfly/patternfly-org/issues/3919)) ([94d3654](https://github.com/patternfly/patternfly-org/commit/94d3654768f42f2ae7b3c0734d1e5f211cd33ff6))
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
## 5.5.1 (2024-03-12)
|
|
116
|
+
|
|
117
|
+
**Note:** Version bump only for package @patternfly/documentation-framework
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
# 5.5.0 (2024-03-08)
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
### Features
|
|
127
|
+
|
|
128
|
+
* **deps:** version bump for 5.2.1 release ([#3913](https://github.com/patternfly/patternfly-org/issues/3913)) ([46cc8b7](https://github.com/patternfly/patternfly-org/commit/46cc8b70e06b9bda61067beba57d928e428b73c5))
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
## 5.4.3 (2024-02-27)
|
|
135
|
+
|
|
136
|
+
**Note:** Version bump only for package @patternfly/documentation-framework
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
## 5.4.2 (2024-02-14)
|
|
143
|
+
|
|
144
|
+
**Note:** Version bump only for package @patternfly/documentation-framework
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
## 5.4.1 (2024-02-06)
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
### Bug Fixes
|
|
154
|
+
|
|
155
|
+
* Bump topology to 5.2.1 ([#3881](https://github.com/patternfly/patternfly-org/issues/3881)) ([af13c97](https://github.com/patternfly/patternfly-org/commit/af13c971384aaaa5bd87ce3e98dccee4b1214889))
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
# 5.4.0 (2024-02-03)
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
### Features
|
|
165
|
+
|
|
166
|
+
* release 5.3 ([#3878](https://github.com/patternfly/patternfly-org/issues/3878)) ([3d1d130](https://github.com/patternfly/patternfly-org/commit/3d1d130c63ac4421ed8a307cd6ef140fa6e1d6f2))
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
## 5.3.27 (2024-02-01)
|
|
173
|
+
|
|
174
|
+
**Note:** Version bump only for package @patternfly/documentation-framework
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
## 5.3.26 (2024-02-01)
|
|
181
|
+
|
|
182
|
+
**Note:** Version bump only for package @patternfly/documentation-framework
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
## 5.3.25 (2024-01-30)
|
|
189
|
+
|
|
190
|
+
**Note:** Version bump only for package @patternfly/documentation-framework
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
## 5.3.24 (2024-01-30)
|
|
197
|
+
|
|
198
|
+
**Note:** Version bump only for package @patternfly/documentation-framework
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
## 5.3.23 (2024-01-19)
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
### Bug Fixes
|
|
208
|
+
|
|
209
|
+
* avoid applying beta tags to nav items for next components ([#3868](https://github.com/patternfly/patternfly-org/issues/3868)) ([169c96f](https://github.com/patternfly/patternfly-org/commit/169c96f55b1bfdcb9859dbab27b88f5a180f48ba))
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
## 5.3.22 (2024-01-16)
|
|
216
|
+
|
|
217
|
+
**Note:** Version bump only for package @patternfly/documentation-framework
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
## 5.3.21 (2024-01-16)
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
### Bug Fixes
|
|
227
|
+
|
|
228
|
+
* bump to latest release candidates ahead of 5.2 release ([#3862](https://github.com/patternfly/patternfly-org/issues/3862)) ([12eeb78](https://github.com/patternfly/patternfly-org/commit/12eeb782d32c4fa65f6aef64292f1e0d92f0d183))
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
## 5.3.20 (2024-01-15)
|
|
235
|
+
|
|
236
|
+
**Note:** Version bump only for package @patternfly/documentation-framework
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
## 5.3.19 (2024-01-15)
|
|
243
|
+
|
|
244
|
+
**Note:** Version bump only for package @patternfly/documentation-framework
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
## 5.3.18 (2024-01-12)
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
### Bug Fixes
|
|
254
|
+
|
|
255
|
+
* bump puppeteer to fix core ([#3860](https://github.com/patternfly/patternfly-org/issues/3860)) ([1695209](https://github.com/patternfly/patternfly-org/commit/169520944b7c3dccf69709e6e2075b9153fce059))
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
## 5.3.17 (2024-01-05)
|
|
262
|
+
|
|
263
|
+
**Note:** Version bump only for package @patternfly/documentation-framework
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
## 5.3.16 (2024-01-03)
|
|
270
|
+
|
|
271
|
+
**Note:** Version bump only for package @patternfly/documentation-framework
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
## 5.3.15 (2023-12-14)
|
|
278
|
+
|
|
279
|
+
**Note:** Version bump only for package @patternfly/documentation-framework
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
6
285
|
# 6.0.0-alpha.20 (2024-04-03)
|
|
7
286
|
|
|
8
287
|
|
package/app.js
CHANGED
|
@@ -3,7 +3,6 @@ import { createRoot, hydrateRoot } from 'react-dom/client';
|
|
|
3
3
|
import { Router, useLocation } from '@reach/router';
|
|
4
4
|
import 'client-styles'; // Webpack replaces this import: patternfly-docs.css.js
|
|
5
5
|
import { SideNavLayout } from '@patternfly/documentation-framework/layouts';
|
|
6
|
-
import { Footer } from '@patternfly/documentation-framework/components';
|
|
7
6
|
import { MDXTemplate } from '@patternfly/documentation-framework/templates/mdx';
|
|
8
7
|
import { routes, groupedRoutes, fullscreenRoutes, getAsyncComponent } from './routes';
|
|
9
8
|
import { trackEvent } from './helpers';
|
|
@@ -37,7 +36,6 @@ const AppRoute = ({ child, title, path }) => {
|
|
|
37
36
|
return (
|
|
38
37
|
<React.Fragment>
|
|
39
38
|
{child}
|
|
40
|
-
{process.env.hasFooter && <Footer />}
|
|
41
39
|
</React.Fragment>
|
|
42
40
|
);
|
|
43
41
|
}
|
|
@@ -46,7 +44,7 @@ const SideNavRouter = () => {
|
|
|
46
44
|
const componentsData = process?.env?.componentsData;
|
|
47
45
|
return (
|
|
48
46
|
<SideNavLayout groupedRoutes={groupedRoutes} navOpen={true} >
|
|
49
|
-
<Router id="ws-page-content-router">
|
|
47
|
+
<Router id="ws-page-content-router" component="main">
|
|
50
48
|
{Object.entries(routes)
|
|
51
49
|
.map(([path, { Component, title, sources, id }]) => Component
|
|
52
50
|
? <AppRoute
|
|
@@ -95,7 +95,7 @@ const ExpandableNav = ({groupedRoutes, location, section, subsection = null}) =>
|
|
|
95
95
|
source.source === "react-deprecated" || source.source === "html-deprecated")
|
|
96
96
|
&& !navObj.sources.some(source => source.source === "react" || source.source === "html")
|
|
97
97
|
),
|
|
98
|
-
isBeta: navObj.sources.some(source => source.beta && source.source !== 'react-next'),
|
|
98
|
+
isBeta: navObj.sources.some(source => source.beta && source.source !== 'react-next' && source.source !== 'react-templates'),
|
|
99
99
|
isDemo: navObj.sources.some(source => (
|
|
100
100
|
source.source === "react-demos" || source.source === "html-demos")
|
|
101
101
|
&& !navObj.sources.some(source => source.source === "react" || source.source === "html")
|
|
@@ -35,6 +35,7 @@ import SunIcon from '@patternfly/react-icons/dist/esm/icons/sun-icon';
|
|
|
35
35
|
import { SideNav, TopNav, GdprBanner } from '../../components';
|
|
36
36
|
import staticVersions from '../../versions.json';
|
|
37
37
|
import v5Logo from '../PF-HorizontalLogo-Reverse.svg';
|
|
38
|
+
import { Footer } from '@patternfly/documentation-framework/components';
|
|
38
39
|
|
|
39
40
|
export const RtlContext = createContext(false);
|
|
40
41
|
|
|
@@ -163,6 +164,20 @@ const HeaderTools = ({
|
|
|
163
164
|
</DropdownList>
|
|
164
165
|
</DropdownGroup>
|
|
165
166
|
)}
|
|
167
|
+
<Divider key="divider1" className="ws-switcher-divider"/>
|
|
168
|
+
<DropdownGroup key="Alpha preview version" label="Alpha preview version">
|
|
169
|
+
<DropdownList>
|
|
170
|
+
<DropdownItem
|
|
171
|
+
key="PatternFly 6"
|
|
172
|
+
className="ws-patternfly-versions"
|
|
173
|
+
isExternalLink
|
|
174
|
+
to="https://staging-v6.patternfly.org/"
|
|
175
|
+
itemId="patternfly-6"
|
|
176
|
+
>
|
|
177
|
+
PatternFly 6
|
|
178
|
+
</DropdownItem>
|
|
179
|
+
</DropdownList>
|
|
180
|
+
</DropdownGroup>
|
|
166
181
|
<Divider key="divider2" className="ws-switcher-divider"/>
|
|
167
182
|
<DropdownGroup key="Previous versions" label="Previous versions">
|
|
168
183
|
<DropdownList>
|
|
@@ -323,6 +338,7 @@ export const SideNavLayout = ({ children, groupedRoutes, navOpen: navOpenProp })
|
|
|
323
338
|
<Page
|
|
324
339
|
id="ws-page"
|
|
325
340
|
mainContainerId="ws-page-main"
|
|
341
|
+
mainComponent="div"
|
|
326
342
|
header={Header}
|
|
327
343
|
sidebar={SideBar}
|
|
328
344
|
skipToContent={<SkipToContent href="#ws-page-main">Skip to content</SkipToContent>}
|
|
@@ -330,6 +346,7 @@ export const SideNavLayout = ({ children, groupedRoutes, navOpen: navOpenProp })
|
|
|
330
346
|
defaultManagedSidebarIsOpen={navOpenProp}
|
|
331
347
|
>
|
|
332
348
|
{children}
|
|
349
|
+
{process.env.hasFooter && <Footer />}
|
|
333
350
|
</Page>
|
|
334
351
|
<div id="ws-page-banners">
|
|
335
352
|
{hasGdprBanner && <GdprBanner />}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@patternfly/documentation-framework",
|
|
3
3
|
"description": "A framework to build documentation for PatternFly.",
|
|
4
|
-
"version": "6.0.0-alpha.
|
|
4
|
+
"version": "6.0.0-alpha.22",
|
|
5
5
|
"author": "Red Hat",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"private": false,
|
|
@@ -9,18 +9,14 @@
|
|
|
9
9
|
"pf-docs-framework": "scripts/cli/cli.js"
|
|
10
10
|
},
|
|
11
11
|
"dependencies": {
|
|
12
|
-
"@babel/core": "7.
|
|
13
|
-
"@babel/
|
|
14
|
-
"@babel/
|
|
15
|
-
"@babel/plugin-proposal-private-methods": "7.17.12",
|
|
16
|
-
"@babel/plugin-proposal-private-property-in-object": "7.17.12",
|
|
17
|
-
"@babel/plugin-transform-react-jsx": "7.17.12",
|
|
18
|
-
"@babel/preset-env": "7.18.2",
|
|
12
|
+
"@babel/core": "^7.24.3",
|
|
13
|
+
"@babel/preset-env": "^7.24.3",
|
|
14
|
+
"@babel/preset-react": "^7.24.1",
|
|
19
15
|
"@mdx-js/util": "1.6.16",
|
|
20
|
-
"@patternfly/ast-helpers": "^1.4.0-alpha.
|
|
16
|
+
"@patternfly/ast-helpers": "^1.4.0-alpha.11",
|
|
21
17
|
"@reach/router": "npm:@gatsbyjs/reach-router@1.3.9",
|
|
22
18
|
"autoprefixer": "9.8.6",
|
|
23
|
-
"babel-loader": "9.1.
|
|
19
|
+
"babel-loader": "^9.1.3",
|
|
24
20
|
"camelcase-css": "2.0.1",
|
|
25
21
|
"chokidar": "3.5.3",
|
|
26
22
|
"clean-webpack-plugin": "4.0.0",
|
|
@@ -84,5 +80,5 @@
|
|
|
84
80
|
"react": "^17.0.0 || ^18.0.0",
|
|
85
81
|
"react-dom": "^17.0.0 || ^18.0.0"
|
|
86
82
|
},
|
|
87
|
-
"gitHead": "
|
|
83
|
+
"gitHead": "65ebcf7e38a208cb3fa313217ed971774d6805ca"
|
|
88
84
|
}
|
|
@@ -56,20 +56,12 @@ module.exports = (_env, argv) => {
|
|
|
56
56
|
options: {
|
|
57
57
|
cacheDirectory: '.cache/babel',
|
|
58
58
|
cacheCompression: false,
|
|
59
|
-
presets: [
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
targets: "> 0.25%, not dead"
|
|
66
|
-
}]],
|
|
67
|
-
plugins: [
|
|
68
|
-
'@babel/plugin-transform-react-jsx',
|
|
69
|
-
'@babel/plugin-proposal-class-properties',
|
|
70
|
-
'@babel/plugin-proposal-optional-chaining',
|
|
71
|
-
["@babel/plugin-proposal-private-methods", { "loose": false }],
|
|
72
|
-
["@babel/plugin-proposal-private-property-in-object", { "loose": false }]
|
|
59
|
+
presets: [
|
|
60
|
+
'@babel/preset-react',
|
|
61
|
+
['@babel/preset-env', {
|
|
62
|
+
loose: true,
|
|
63
|
+
targets: '> 1%, not dead'
|
|
64
|
+
}],
|
|
73
65
|
],
|
|
74
66
|
}
|
|
75
67
|
},
|
package/templates/mdx.css
CHANGED
package/templates/mdx.js
CHANGED
|
@@ -158,7 +158,7 @@ export const MDXTemplate = ({
|
|
|
158
158
|
componentsData
|
|
159
159
|
}) => {
|
|
160
160
|
const isDeprecated = sources.some(source => source.source === "react-deprecated" || source.source === "html-deprecated") && !sources.some(source => source.source === "react" || source.source === "html");
|
|
161
|
-
const isBeta = sources.some(source => source.beta && source.source !== 'react-next')
|
|
161
|
+
const isBeta = sources.some(source => source.beta && source.source !== 'react-next' && source.source !== 'react-templates');
|
|
162
162
|
const isDemo = sources.some(source => source.source === "react-demos" || source.source === "html-demos") && !sources.some(source => source.source === "react" || source.source === "html");
|
|
163
163
|
// Build obj mapping source names to text displayed on tabs
|
|
164
164
|
const tabNames = sources.reduce((acc, curSrc) => {
|