Skip to content

Commit 595e6a2

Browse files
fix: Reorganizes and renames nav items for new design. (#4861)
* docs: Reorganizes and renames nav items for new design. * Smoothing out issues and adding missing changes * Fix frontmatter in tokens page * Add original PatternFly-AI/about-generative-ui.md to resolve GitHub merge conflict This is a temporary workaround to satisfy GitHub's conflict detection. The file will be removed in a follow-up PR after the merge is complete. * Update alert message * Adds training section and removes contribute page for followup pr * Updates link * fix some docs * lots of fixes plus adding screenshots --------- Co-authored-by: nicolethoen <nthoen@redhat.com>
1 parent 983f822 commit 595e6a2

File tree

1,622 files changed

+699
-725
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,622 files changed

+699
-725
lines changed

package.json

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@
3636
},
3737
"devDependencies": {
3838
"@octokit/rest": "^19.0.7",
39-
"@patternfly/patternfly": "^6.5.0-prerelease.23",
40-
"@patternfly/react-code-editor": "^6.5.0-prerelease.11",
41-
"@patternfly/react-core": "^6.5.0-prerelease.11",
42-
"@patternfly/react-table": "^6.5.0-prerelease.11",
39+
"@patternfly/patternfly": "^6.5.0-prerelease.27",
40+
"@patternfly/react-code-editor": "^6.5.0-prerelease.13",
41+
"@patternfly/react-core": "^6.5.0-prerelease.13",
42+
"@patternfly/react-table": "^6.5.0-prerelease.13",
4343
"@rspack/cli": "^1.5.6",
4444
"@rspack/core": "^1.5.6",
4545
"@rspack/dev-server": "^1.1.4",
@@ -65,8 +65,9 @@
6565
"ip": ">=2.0.0",
6666
"http-cache-semantics": ">=4.1.1",
6767
"nanoid": "3.3.8",
68-
"@patternfly/react-code-editor": "^6.5.0-prerelease.11",
69-
"@patternfly/react-core": "^6.5.0-prerelease.11",
70-
"@patternfly/react-table": "^6.5.0-prerelease.11"
68+
"@patternfly/react-code-editor": "^6.5.0-prerelease.13",
69+
"@patternfly/react-core": "^6.5.0-prerelease.13",
70+
"@patternfly/react-table": "^6.5.0-prerelease.13",
71+
"monaco-editor": "0.54.0"
7172
}
7273
}

packages/documentation-framework/components/example/exampleToolbar.jsx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,16 @@ export const ExampleToolbar = ({
195195
// TODO: check if worth adding react, patternfly, and example types
196196
// https://microsoft.github.io/monaco-editor/api/interfaces/monaco.languages.typescript.languageservicedefaults.html#addextralib
197197
const onEditorDidMount = (_editor, monaco) => {
198+
// Configure Monaco environment for web workers (required for Monaco 0.54+)
199+
if (typeof window !== 'undefined' && !window.MonacoEnvironment) {
200+
window.MonacoEnvironment = {
201+
getWorker() {
202+
// Return empty worker since we disable all diagnostics below anyway
203+
return new Worker(URL.createObjectURL(new Blob([''], { type: 'application/javascript' })));
204+
}
205+
};
206+
}
207+
198208
monaco.languages.typescript.typescriptDefaults.setCompilerOptions({
199209
jsx: true,
200210
...monaco.languages.typescript.typescriptDefaults.getCompilerOptions()

packages/documentation-framework/components/footer/footer.js

Lines changed: 5 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -30,68 +30,12 @@ export const Footer = ({ isDarkTheme }) => (
3030
<Grid className="pf-v6-u-py-xl">
3131
<GridItem
3232
sm={6}
33-
md={4}
33+
md={6}
3434
className="pf-v6-u-ml-md pf-v6-u-ml-0-on-md pf-v6-u-mb-xl pf-v6-u-mb-0-on-md"
35-
>
36-
<p className="ws-org-pfsite-footer-menu-list-title">What's new</p>
37-
<nav aria-label="Quick Links">
38-
<List isPlain className="ws-org-pfsite-footer-menu-list">
39-
<ListItem className="ws-org-pfsite-footer-menu-list-item">
40-
<Link
41-
className="ws-org-pfsite-footer-menu-link"
42-
to="/get-started/upgrade"
43-
aria-label="Latest PatternFly upgrade guide"
44-
>
45-
Upgrade
46-
</Link>
47-
</ListItem>
48-
<ListItem className="ws-org-pfsite-footer-menu-list-item">
49-
<Link
50-
className="ws-org-pfsite-footer-menu-link"
51-
to="/get-started/release-highlights/"
52-
aria-label="PatternFly release highlights"
53-
>
54-
Releases
55-
</Link>
56-
</ListItem>
57-
<ListItem className="ws-org-pfsite-footer-menu-list-item">
58-
<Link
59-
className="ws-org-pfsite-footer-menu-link"
60-
to="/patternfly-ai/about-ai"
61-
aria-label="PatternFly's new AI resources"
62-
>
63-
PatternFly AI
64-
</Link>
65-
</ListItem>
66-
<ListItem className="ws-org-pfsite-footer-menu-list-item">
67-
<Link
68-
className="ws-org-pfsite-footer-menu-link"
69-
to="/tokens/about-tokens"
70-
aria-label="PatternFly's new token system"
71-
>
72-
Tokens
73-
</Link>
74-
</ListItem>
75-
</List>
76-
</nav>
77-
</GridItem>
78-
<GridItem
79-
sm={6}
80-
md={4}
81-
className="pf-v6-u-mt-lg pf-v6-u-mt-0-on-sm pf-v6-u-ml-md pf-v6-u-ml-0-on-md pf-v6-u-mb-xl pf-v6-u-mb-0-on-md"
8235
>
8336
<p className="ws-org-pfsite-footer-menu-list-title">Contribute</p>
8437
<nav aria-label="Contribute">
8538
<List isPlain className="ws-org-pfsite-footer-menu-list">
86-
<ListItem className="ws-org-pfsite-footer-menu-list-item">
87-
<Link
88-
className="ws-org-pfsite-footer-menu-link"
89-
to="/get-started/about-patternfly"
90-
aria-label="Learn about PatternFly"
91-
>
92-
About PatternFly
93-
</Link>
94-
</ListItem>
9539
<ListItem className="ws-org-pfsite-footer-menu-list-item">
9640
<Link
9741
className="ws-org-pfsite-footer-menu-link"
@@ -101,22 +45,13 @@ export const Footer = ({ isDarkTheme }) => (
10145
Code of conduct
10246
</Link>
10347
</ListItem>
104-
<ListItem className="ws-org-pfsite-footer-menu-list-item">
105-
<Link
106-
className="ws-org-pfsite-footer-menu-link"
107-
to="/get-started/contribute"
108-
aria-label="Learn how to contribute to PatternFly"
109-
>
110-
Contribute
111-
</Link>
112-
</ListItem>
11348
</List>
11449
</nav>
11550
</GridItem>
11651
<GridItem
11752
sm={6}
118-
md={4}
119-
className="pf-v6-u-mt-lg pf-v6-u-mt-0-on-md pf-v6-u-ml-md pf-v6-u-ml-0-on-md"
53+
md={6}
54+
className="pf-v6-u-mt-lg pf-v6-u-mt-0-on-sm pf-v6-u-ml-md pf-v6-u-ml-0-on-md"
12055
>
12156
<p className="ws-org-pfsite-footer-menu-list-title">Community</p>
12257
<nav aria-label="Stay in touch">
@@ -138,7 +73,7 @@ export const Footer = ({ isDarkTheme }) => (
13873
target="top"
13974
aria-label="Read the PatternFly blog"
14075
>
141-
Blog
76+
Medium
14277
</Link>
14378
</ListItem>
14479
<ListItem className="ws-org-pfsite-footer-menu-list-item">
@@ -167,7 +102,7 @@ export const Footer = ({ isDarkTheme }) => (
167102
target="top"
168103
aria-label="Visit the PatternFly discussion forum"
169104
>
170-
Discussions
105+
GitHub Discussions
171106
</Link>
172107
</ListItem>
173108
</List>

packages/documentation-framework/components/index.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ export * from './example/example';
55
export * from './footer/footer';
66
export * from './gdprBanner/gdprBanner';
77
export * from './propsTable/propsTable';
8+
export * from './navAnnouncementBanner/navAnnouncementBanner';
89
export * from './sideNav/sideNav';
910
export * from './topNav/topNav';
1011
export * from './link/link';
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.ws-nav-announcement-banner-container {
2+
position: fixed;
3+
top: 20px;
4+
left: 0;
5+
right: 0;
6+
width: 100%;
7+
z-index: 300;
8+
display: flex;
9+
justify-content: center;
10+
padding: 0 var(--pf-t--global--spacer--xl);
11+
pointer-events: none;
12+
}
13+
14+
.ws-nav-announcement-banner {
15+
max-width: 85vw;
16+
width: 100%;
17+
box-shadow: var(--pf-t--global--box-shadow--md);
18+
pointer-events: auto;
19+
}
20+
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
import React from 'react';
2+
import { Alert, AlertActionCloseButton } from '@patternfly/react-core';
3+
import './navAnnouncementBanner.css';
4+
5+
export const NavAnnouncementBanner = () => {
6+
const initialBannerOpen = typeof window !== 'undefined' && window.localStorage && !localStorage.getItem('nav-announcement-banner-closed');
7+
const [ isBannerOpen, setBannerOpen ] = React.useState(initialBannerOpen);
8+
9+
const closeBanner = () => {
10+
localStorage.setItem('nav-announcement-banner-closed', 'true');
11+
setBannerOpen(false);
12+
}
13+
14+
return !isBannerOpen ? null : (
15+
<div className="ws-nav-announcement-banner-container">
16+
<Alert
17+
variant="info"
18+
isInline
19+
actionClose={<AlertActionCloseButton onClose={closeBanner} />}
20+
className="ws-nav-announcement-banner"
21+
title={<>We've redesigned our website's navigation menu to make it easier to find the information you need. Learn more about the changes on <a href="https://medium.com/patternfly" target="_blank" rel="noopener noreferrer">Medium</a> and share any thoughts in our <a href="https://www.feedback.redhat.com/jfe/form/SV_9MKBjq8H7muINMy" target="_blank" rel="noopener noreferrer">user feedback survey</a>.</>}
22+
/>
23+
</div>
24+
);
25+
}

packages/documentation-framework/components/sideNav/sideNav.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ import { css } from '@patternfly/react-styles';
1616
import { Location } from '@reach/router';
1717

1818
const DIVIDER_STYLES = {
19-
marginTop: 'var(--pf-t--global--spacer--md)',
20-
marginBottom: 'var(--pf-t--global--spacer--md)'
19+
marginTop: 'var(--pf-t--global--spacer--xs)',
20+
marginBottom: 'var(--pf-t--global--spacer--xs)'
2121
};
2222
import { makeSlug } from '../../helpers';
2323
import globalBreakpointXl from '@patternfly/react-tokens/dist/esm/t_global_breakpoint_xl';

packages/documentation-framework/layouts/sideNavLayout/sideNavLayout.js

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import {
2727
} from '@patternfly/react-core';
2828
import BarsIcon from '@patternfly/react-icons/dist/esm/icons/bars-icon';
2929
import GithubIcon from '@patternfly/react-icons/dist/esm/icons/github-icon';
30-
import { SideNav, TopNav, GdprBanner, ThemeSelector } from '../../components';
30+
import { SideNav, TopNav, GdprBanner, NavAnnouncementBanner, ThemeSelector } from '../../components';
3131
import staticVersions from '../../versions.json';
3232
import { Footer } from '@patternfly/documentation-framework/components';
3333
import { useTheme, THEME_TYPES } from '../../hooks/useTheme';
@@ -363,7 +363,10 @@ export const SideNavLayout = ({ children, groupedRoutes, navOpen: navOpenProp })
363363
{children}
364364
{process.env.hasFooter && <Footer isDarkTheme={isDarkTheme} />}
365365
</Page>
366-
<div id="ws-page-banners">{hasGdprBanner && <GdprBanner />}</div>
366+
<div id="ws-page-banners">
367+
<NavAnnouncementBanner />
368+
{hasGdprBanner && <GdprBanner />}
369+
</div>
367370
</RtlContext.Provider>
368371
</React.Fragment>
369372
);

packages/documentation-framework/package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,10 @@
6666
"webpack-merge": "5.8.0"
6767
},
6868
"peerDependencies": {
69-
"@patternfly/patternfly": "^6.5.0-prerelease.23",
70-
"@patternfly/react-code-editor": "^6.5.0-prerelease.11",
71-
"@patternfly/react-core": "^6.5.0-prerelease.11",
72-
"@patternfly/react-table": "^6.5.0-prerelease.11",
69+
"@patternfly/patternfly": "^6.5.0-prerelease.27",
70+
"@patternfly/react-code-editor": "^6.5.0-prerelease.13",
71+
"@patternfly/react-core": "^6.5.0-prerelease.13",
72+
"@patternfly/react-table": "^6.5.0-prerelease.13",
7373
"react": "^17.0.0 || ^18.0.0",
7474
"react-dom": "^17.0.0 || ^18.0.0"
7575
},

packages/documentation-framework/pages/404/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ const Page404 = () => {
7777
body="Learn about designing and developing with PatternFly."
7878
link={{
7979
text: 'View getting started resources',
80-
to: '/get-started/about-patternfly',
80+
to: '/about-us',
8181
}}
8282
/>
8383
<Card404

0 commit comments

Comments
 (0)