@patternfly/documentation-framework 2.0.0-alpha.63 → 2.0.0-alpha.65

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# 2.0.0-alpha.65 (2023-06-15)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.64 (2023-06-15)
+
+
+### Bug Fixes
+
+* **Sidenav:** updated PageContext props ([#3593](https://github.com/patternfly/patternfly-org/issues/3593)) ([1cc24ea](https://github.com/patternfly/patternfly-org/commit/1cc24ea1ef88c42a6b62a4a6b2421d157bc298d8))
+
+
+
+
+
 # 2.0.0-alpha.63 (2023-06-14)
 
 **Note:** Version bump only for package @patternfly/documentation-framework

package/README.md

@@ -1,6 +1,6 @@
 # @patternfly/documentation-framework
 
-## The PatternFly documentation framework lets you develop component examples in markdown format, so that they can be added to [patternfly.org](https://www.patternfly.org/v4/).
+## The PatternFly documentation framework lets you develop component examples in markdown format, so that they can be added to [patternfly.org](https://www.patternfly.org/).
 
 ## Install
 

package/app.js

@@ -23,6 +23,13 @@ const AppRoute = ({ child, title, path }) => {
       'page_title': (title || pathname)
     });
   }
+
+  // Redirect all v4 url paths to the archived v4 site
+  if(pathname.startsWith("/v4")){
+    window.location.href = `https://v4-archive.patternfly.org${pathname}`;
+    return;
+  }
+
   // Send 404 event if redirected to 404 page
   if (path === '/404' && pathname.split('/').pop() !== '404') {
     trackEvent('404_redirect', 'redirect', pathname);
@@ -36,7 +43,6 @@ const AppRoute = ({ child, title, path }) => {
 }
 
 const SideNavRouter = () => {
-  const pathname = useLocation().pathname.replace(process.env.pathPrefix, '');
   const componentsData = process?.env?.componentsData;
   return (
     <SideNavLayout groupedRoutes={groupedRoutes} navOpen={true} >
@@ -83,7 +89,7 @@ const FullscreenComponent = ({ Component, title }) => {
 
 // Export for SSR
 export const App = () => (
-  <Router basepath={process.env.pathPrefix} id="ws-router">
+  <Router id="ws-router">
     <SideNavRouter path="/*" />
     {Object.entries(fullscreenRoutes)
       .map(([path, { title, Component }]) =>

package/components/link/link.js

@@ -39,8 +39,6 @@ export const Link = ({
     return <a href={url} onClick={onClick} {...props} />;
   }
   else if (url.startsWith('/')) {
-    url = `${process.env.pathPrefix}/${url.substr(1)}`;
-
     if (!process.env.PRERENDER) {
       const Component = getAsyncComponent(url);
       if (Component) {
@@ -65,5 +63,6 @@ export const Link = ({
       }
     }
   }
+
   return <ReachLink to={url} {...props} />;
 }

package/components/sideNav/sideNav.js

@@ -9,7 +9,7 @@ import { trackEvent } from '../../helpers';
 
 const getIsActive = (location, section, subsection = null) => {
   const slug = makeSlug(null, section, null, null, subsection);
-  return location.pathname.startsWith(`${process.env.pathPrefix}${slug}`);
+  return location.pathname.startsWith(slug);
 }
 
 const defaultValue = 50;
@@ -18,8 +18,8 @@ const NavItem = ({ text, href, isDeprecated, isBeta, isDemo }) => {
   const isMobileView = window.innerWidth < Number.parseInt(globalBreakpointXl.value, 10);
   return (
     <PageContextConsumer key={href + text}>
-      {({onNavToggle, isNavOpen }) => (
-          <li key={href + text} className="pf-v5-c-nav__item" onClick={() => isMobileView && onNavToggle && onNavToggle()}>
+      {({onSidebarToggle, isSidebarOpen }) => (
+          <li key={href + text} className="pf-v5-c-nav__item" onClick={() => isMobileView && onSidebarToggle && onSidebarToggle()}>
             <Link
               to={href}
               getProps={({ isCurrent, href, location }) => {
@@ -31,7 +31,7 @@ const NavItem = ({ text, href, isDeprecated, isBeta, isDemo }) => {
                   )
                 }}
               }
-              tabIndex={isNavOpen ? undefined : -1}
+              tabIndex={isSidebarOpen ? undefined : -1}
             >
               <Flex spaceItems={{ default: 'spaceItemsSm'}}>
                 <FlexItem>{text}</FlexItem>

package/helpers/codesandbox.js

@@ -2,15 +2,13 @@ const { parse } = require('@patternfly/ast-helpers');
 const versions  = require('../versions.json');
 const overpass = require('./fonts');
 const { capitalize } = require('./capitalize');
-const path = require('path');
-const pathPrefix = process.env.pathPrefix;
 
 const getStaticParams = (title, html) => {
   const imgAssetRegex = /['"](\/assets\/images\/.*)['"]/g;
   let imgAsset;
   while ((imgAsset = imgAssetRegex.exec(html))) {
     const imgName = imgAsset[1];
-    html = html.replace(imgName, `https://www.patternfly.org/v4${imgName}`);
+    html = html.replace(imgName, `https://www.patternfly.org${imgName}`);
   }
 
   return {

package/layouts/sideNavLayout/sideNavLayout.js

@@ -38,8 +38,7 @@ const HeaderTools = ({
   hasVersionSwitcher,
   algolia,
   hasDarkThemeSwitcher,
-  topNavItems,
-  pathPrefix
+  topNavItems
 }) => {
   const initialVersion = staticVersions.Releases.find(release => release.latest);
   const latestVersion = versions.Releases.find(version => version.latest);
@@ -190,7 +189,6 @@ export function attachDocSearch(algolia, inputSelector, timeout) {
 }
 
 export const SideNavLayout = ({ children, groupedRoutes, navOpen: navOpenProp }) => {
-  const pathPrefix = process.env.pathPrefix;
   const algolia = process.env.algolia;
   const hasGdprBanner = process.env.hasGdprBanner;
   const hasVersionSwitcher = process.env.hasVersionSwitcher;
@@ -234,7 +232,7 @@ export const SideNavLayout = ({ children, groupedRoutes, navOpen: navOpenProp })
         </PageToggleButton>
       </MastheadToggle>
       <MastheadMain>
-        <MastheadBrand href={prurl || pathPrefix || '/'}>
+        <MastheadBrand href={prurl || '/'}>
           {prnum ? `PR #${prnum}` : (
             <Brand src={logoBase} alt="PatternFly logo" widths={{ default: '180px', '2xl': '220px' }}>
               <source media="(min-width: 768px)" srcSet={logoMd} />
@@ -250,7 +248,6 @@ export const SideNavLayout = ({ children, groupedRoutes, navOpen: navOpenProp })
             algolia={algolia}
             hasVersionSwitcher={hasVersionSwitcher}
             hasDarkThemeSwitcher={hasDarkThemeSwitcher}
-            pathPrefix={pathPrefix}
             topNavItems={topNavItems}
           />
         )}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@patternfly/documentation-framework",
   "description": "A framework to build documentation for PatternFly.",
-  "version": "2.0.0-alpha.63",
+  "version": "2.0.0-alpha.65",
   "author": "Red Hat",
   "license": "MIT",
   "private": false,
@@ -91,5 +91,5 @@
     "react": "^17.0.0 || ^18.0.0",
     "react-dom": "^17.0.0 || ^18.0.0"
   },
-  "gitHead": "947fc98c2043b97ae2f634fe52858338ea33b8fd"
+  "gitHead": "d4886e73fdacf6ec830e534c830f5114bb1fbcd8"
 }

package/routes.js

@@ -145,8 +145,6 @@ function getAsyncComponent(url) {
   if (!url && typeof window !== 'undefined') {
     url = window.location.pathname.replace(/\/$/, '') || '/';
   }
-  // Normalize path for matching
-  url = url.replace(process.env.pathPrefix, '');
   let res;
 
   if (allRoutes[url]) {

package/scripts/cli/build.js

@@ -86,7 +86,6 @@ async function build(cmd, options) {
   config.legacySSL = options.legacySSL
 
   // These get passed to `fork`ed builds
-  process.env.pathPrefix = config.pathPrefix;
   process.env.hasDesignGuidelines = config.hasDesignGuidelines;
   // console.log('build', cmd, options.parent.cssconfig);
   if (toBuild.includes('server')) {

package/scripts/cli/cli.js

@@ -44,7 +44,7 @@ program
 
 program
   .command('screenshots')
-  .option('-u, --urlPrefix <prefix>', 'where fullscreen pages are hosted', 'http://localhost:5000/v4')
+  .option('-u, --urlPrefix <prefix>', 'where fullscreen pages are hosted', 'http://localhost:5000')
   .option('-a, --allRoutes', 'true if screenshots of all examples - not just full screen', false)
   .description('updates screenshots for generated components')
   .action(options => {

package/scripts/webpack/getHtmlWebpackPlugins.js

@@ -9,7 +9,6 @@ async function getHtmlWebpackPlugin({
   isProd,
   googleAnalyticsID,
   algolia,
-  pathPrefix = '',
   url,
   title,
   isFullscreen
@@ -20,7 +19,7 @@ async function getHtmlWebpackPlugin({
     templateParameters: {
       title: getTitle(title),
       // Don't prerender fullscreen pages (expensive!)
-      prerendering: (isProd && !isFullscreen && !url.includes('topology') && !url.includes('extensions')) ? await prerender(url, pathPrefix) : null,
+      prerendering: (isProd && !isFullscreen && !url.includes('topology') && !url.includes('extensions')) ? await prerender(url) : null,
       // Don't use GA in dev mode
       googleAnalyticsID: isProd ? googleAnalyticsID : false,
       algolia

package/scripts/webpack/prerender.js

@@ -8,8 +8,7 @@ const ssrPrepass = require('react-ssr-prepass');
 
 // This function is effectively synchronous because it mutates global.setTimeout
 // Only allow one copy at a time to run
-async function prerender(url, pathPrefix) {
-  url = `${pathPrefix}${url}`;
+async function prerender(url) {
   const location = { pathname: url };
   // For @reach/router
   global.history = {};

package/scripts/webpack/webpack.base.config.js

@@ -6,7 +6,6 @@ const MonacoWebpackPlugin = require('monaco-editor-webpack-plugin');
 
 module.exports = (_env, argv) => {
   const {
-    pathPrefix = '',
     mode,
     googleAnalyticsID = false,
     algolia = {},
@@ -26,7 +25,7 @@ module.exports = (_env, argv) => {
   return {
     entry: path.resolve(__dirname, '../../app.js'),
     output: {
-      publicPath: isProd ? `${pathPrefix}/` : '/',
+      publicPath: '/',
       pathinfo: false, // https://webpack.js.org/guides/build-performance/#output-without-path-info,
       hashDigestLength: 8,
       clean: true, // Clean the output directory before emit.
@@ -137,7 +136,6 @@ module.exports = (_env, argv) => {
       }),
       new webpack.DefinePlugin({
         'process.env.NODE_ENV': JSON.stringify(mode),
-        'process.env.pathPrefix': JSON.stringify(isProd ? pathPrefix : ''),
         'process.env.googleAnalyticsID': JSON.stringify(isProd ? googleAnalyticsID : ''),
         'process.env.algolia': JSON.stringify(algolia),
         'process.env.hasGdprBanner': JSON.stringify(hasGdprBanner),

package/templates/sitemap.ejs

@@ -2,7 +2,7 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
   <% urls.forEach(url => {%>
   <url>
-    <loc>https://www.patternfly.org/v4<%=url%></loc>
+    <loc>https://www.patternfly.org<%=url%></loc>
     <changefreq>daily</changefreq>
     <priority>0.7</priority>
   </url>