@patternfly/documentation-framework 1.10.3 → 2.0.0-alpha.10

package/CHANGELOG.md

@@ -3,7 +3,7 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## 1.10.3 (2023-03-13)
+# 2.0.0-alpha.10 (2023-03-15)
 
 **Note:** Version bump only for package @patternfly/documentation-framework
 
@@ -11,37 +11,37 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 
 
 
-## 1.10.2 (2023-03-08)
+# 2.0.0-alpha.9 (2023-03-09)
 
 
 ### Bug Fixes
 
-* **menu:** update and clarify description ([#3438](https://github.com/patternfly/patternfly-org/issues/3438)) ([d06eb61](https://github.com/patternfly/patternfly-org/commit/d06eb619e6bfd185ade10fcfcd703003ec0e606f))
+* **versions:** fix typo ([a9b8fe2](https://github.com/patternfly/patternfly-org/commit/a9b8fe296a9c28bdd9ada01a80b1653810802ddf))
 
 
 
 
 
-## 1.10.1 (2023-03-02)
+# 2.0.0-alpha.8 (2023-03-03)
 
-**Note:** Version bump only for package @patternfly/documentation-framework
 
+### Features
 
+* **docs-framework:** add legacy ssl cli option ([#3433](https://github.com/patternfly/patternfly-org/issues/3433)) ([ccb56fb](https://github.com/patternfly/patternfly-org/commit/ccb56fb27026ebe4be5f5166a86cf3c2f995a872))
 
 
 
-# 1.10.0 (2023-03-01)
 
 
-### Features
+# 2.0.0-alpha.7 (2023-03-01)
 
-* **docs:** add react console documentation ([#3366](https://github.com/patternfly/patternfly-org/issues/3366)) ([f3eb5bf](https://github.com/patternfly/patternfly-org/commit/f3eb5bf0ee2557c93068e01e68de1953d6f67716))
+**Note:** Version bump only for package @patternfly/documentation-framework
 
 
 
 
 
-## 1.9.2 (2023-03-01)
+# 2.0.0-alpha.6 (2023-03-01)
 
 **Note:** Version bump only for package @patternfly/documentation-framework
 
@@ -49,58 +49,56 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 
 
 
-## 1.9.1 (2023-02-27)
-
-**Note:** Version bump only for package @patternfly/documentation-framework
-
+# 2.0.0-alpha.5 (2023-03-01)
 
 
+### Bug Fixes
 
+* **404 Page:** Removed CardHeaderMain ([#3429](https://github.com/patternfly/patternfly-org/issues/3429)) ([6169fed](https://github.com/patternfly/patternfly-org/commit/6169fedd3dc57b9c206197c498d6cebc559e2a93))
 
-# 1.9.0 (2023-02-27)
 
 
-### Features
 
-* **trainings:** remove broken trainings and replace some with blog style training ([#3353](https://github.com/patternfly/patternfly-org/issues/3353)) ([a8dee99](https://github.com/patternfly/patternfly-org/commit/a8dee99d6b4d1f702b070653a6823e389f7d9759))
 
+# 2.0.0-alpha.4 (2023-02-27)
 
 
+### Bug Fixes
 
+* **README:** small wording change to test build ([45ede1b](https://github.com/patternfly/patternfly-org/commit/45ede1b356392df6982fd5cbf3b3a4d976f54e06))
 
-## 1.8.1 (2023-02-20)
 
-**Note:** Version bump only for package @patternfly/documentation-framework
 
 
 
+# 2.0.0-alpha.3 (2023-02-13)
 
 
-# 1.8.0 (2023-02-09)
+### Bug Fixes
 
+* **whitespace:** test github actions ([de769f0](https://github.com/patternfly/patternfly-org/commit/de769f0d47e770af07caf9370ae72f76ab66c8a8))
 
-### Features
 
-* **docs:** enabled manual ordering of sidenav ([#3403](https://github.com/patternfly/patternfly-org/issues/3403)) ([b630ed9](https://github.com/patternfly/patternfly-org/commit/b630ed9e7062e1302d58793bfec65d49da7764d3))
 
 
 
+# 2.0.0-alpha.2 (2023-02-13)
 
 
-# 1.7.0 (2023-02-09)
+### Bug Fixes
 
+* **whitespace:** test github actions ([2e04c13](https://github.com/patternfly/patternfly-org/commit/2e04c137472fe5b4bd96c25cc32ab9c45238f70b))
 
-### Features
 
-* **docs:** customize tabs with optional tabText frontmatter ([#3394](https://github.com/patternfly/patternfly-org/issues/3394)) ([093c6c7](https://github.com/patternfly/patternfly-org/commit/093c6c77053f544605d40f8918dc5621829ac7c3))
 
 
 
+# 2.0.0-alpha.1 (2023-02-13)
 
 
-## 1.6.1 (2023-02-09)
+### Features
 
-**Note:** Version bump only for package @patternfly/documentation-framework
+* **v5:** pull in alphas, set up doc-framework alpha ([#3401](https://github.com/patternfly/patternfly-org/issues/3401)) ([082d048](https://github.com/patternfly/patternfly-org/commit/082d048f33505fb1efc39a3c9928d1552c7f9cea))
 
 
 

package/app.js

@@ -19,7 +19,7 @@ import './layouts/sideNavLayout/sideNavLayout.css';
 const AppRoute = ({ child, katacodaLayout, title, path }) => {
   const pathname = useLocation().pathname;
   if (typeof window !== 'undefined' && window.gtag) {
-    gtag('config', process.env.googleAnalyticsID, {
+    gtag('config', 'UA-47523816-6', {
       'page_path': pathname,
       'page_title': (title || pathname)
     });

package/components/sideNav/sideNav.js

@@ -12,8 +12,6 @@ const getIsActive = (location, section, subsection = null) => {
   return location.pathname.startsWith(`${process.env.pathPrefix}${slug}`);
 }
 
-const defaultValue = 50;
-
 const NavItem = ({ text, href }) => {
   const isMobileView = window.innerWidth < Number.parseInt(globalBreakpointXl.value, 10);
   return (
@@ -69,14 +67,9 @@ const ExpandableNav = ({groupedRoutes, location, section, subsection = null}) =>
       }}
     >
       {Object.entries(routes || {})
-        .filter(([id, navObj]) => !Boolean(navObj.hideNavItem) && (Object.entries(navObj).length > 0))
-        .map(([id, { slug, isSubsection = false, sortValue = defaultValue, subsectionSortValue = defaultValue }]) => ({ text: id, href: slug, isSubsection, sortValue: (isSubsection ? subsectionSortValue : sortValue) }))
-        .sort(({text: text1, sortValue: sortValue1}, {text: text2, sortValue: sortValue2}) => {
-          if (sortValue1 === sortValue2) {
-            return text1.localeCompare(text2);
-          }
-          return sortValue1 > sortValue2 ? 1 : -1;
-        })
+        .filter(([id, { hideNavItem }]) => !Boolean(hideNavItem) && (id !== 'isSubsection'))
+        .map(([id, { slug, isSubsection = false }]) => ({ text: id, href: slug, isSubsection }))
+        .sort(({ text: text1 }, { text: text2 }) => text1.localeCompare(text2))
         .map(navObj => navObj.isSubsection
           ? ExpandableNav({groupedRoutes, location, section, subsection: navObj.text})
           : NavItem(navObj)

package/helpers/getTitle.js

@@ -1,5 +1,5 @@
 module.exports = {
   getTitle(title) {
-    return `PatternFly 4${title ? ` • ${title}` : ''}`;
+    return `PatternFly${title ? ` • ${title}` : ''}`;
   }
-}
+}

package/package.json

@@ -1,10 +1,14 @@
 {
   "name": "@patternfly/documentation-framework",
   "description": "A framework to build documentation for PatternFly.",
-  "version": "1.10.3",
+  "version": "2.0.0-alpha.10",
   "author": "Red Hat",
   "license": "MIT",
   "private": false,
+  "publishConfig": {
+    "access": "public",
+    "tag": "alpha"
+  },
   "bin": {
     "pf-docs-framework": "scripts/cli/cli.js"
   },
@@ -77,12 +81,12 @@
     "webpack-merge": "5.8.0"
   },
   "peerDependencies": {
-    "@patternfly/patternfly": ">=4.185.1",
-    "@patternfly/react-code-editor": ">=4.43.16",
-    "@patternfly/react-core": ">=4.202.16",
-    "@patternfly/react-table": ">=4.71.16",
-    "react": "^16.8.0 || ^17.0.0",
-    "react-dom": "^16.8.0 || ^17.0.0"
+    "@patternfly/patternfly": "^5.0.0-alpha.13",
+    "@patternfly/react-code-editor": "^5.0.0-alpha.7",
+    "@patternfly/react-core": "^5.0.0-alpha.7",
+    "@patternfly/react-table": "^5.0.0-alpha.7",
+    "react": "^17.0.0 || ^18.0.0",
+    "react-dom": "^17.0.0 || ^18.0.0"
   },
-  "gitHead": "c1e36fc4d13426a29a59b6043e2f323af2363897"
+  "gitHead": "3b383cc2f3e0d94a1b88f1b72c6c7f10537928a4"
 }

package/pages/404/index.js

@@ -6,7 +6,7 @@ import {
   CardTitle,
   CardBody,
   CardFooter,
-  CardHeaderMain,
+  CardHeader,
   EmptyState,
   EmptyStateBody,
   EmptyStateIcon,
@@ -36,9 +36,9 @@ const Card404 = ({
 }) => (
   <GridItem xl={3} md={6} xs={12}>
     <Card style={{ height: '340px' }}>
-      <CardHeaderMain className="ws-404-card-header">
+      <CardHeader className="ws-404-card-header">
         <img src={img} alt={alt} width="64px" />
-      </CardHeaderMain>
+      </CardHeader>
       <CardTitle>
         {title}
       </CardTitle>

package/routes.js

@@ -9,8 +9,6 @@ const routes = {
   ...generatedRoutes
 };
 
-const defaultOrder = 50;
-
 for (let route in routes) {
   const pageData = routes[route];
   if (pageData.SyncComponent) {
@@ -30,7 +28,7 @@ const isNull = o => o === null || o === undefined;
 const groupedRoutes = Object.entries(routes)
   .filter(([_slug, { id, section }]) => !isNull(id) && !isNull(section))
   .reduce((accum, [slug, pageData]) => {
-    const { section, subsection = null, id, title, source, katacodaLayout, hideNavItem, relPath, sortValue = null, subsectionSortValue = null } = pageData;
+    const { section, subsection = null, id, title, source, katacodaLayout, hideNavItem, relPath } = pageData;
     pageData.slug = slug;
     // add section to groupedRoutes obj if not yet created
     accum[section] = accum[section] || {};
@@ -44,9 +42,7 @@ const groupedRoutes = Object.entries(routes)
       sources: [],
       katacodaLayout,
       hideNavItem,
-      relPath,
-      ...(sortValue && { sortValue }),
-      ...(subsectionSortValue && { subsectionSortValue })
+      relPath
     }
     // add page to groupedRoutes obj section or subsection
     if (subsection) {
@@ -56,21 +52,10 @@ const groupedRoutes = Object.entries(routes)
       // add page to subsection
       accum[section][subsection][id] = accum[section][subsection][id] || data;
       accum[section][subsection][id].sources.push(pageData);
-      // nav item ordering
-      if (sortValue) {
-        accum[section][subsection].sortValue = sortValue;
-      }
-      if (subsectionSortValue) {
-        accum[section][subsection].subsectionSortValue = subsectionSortValue;
-      }
     } else {
       // add page to section
       accum[section][id] = accum[section][id] || data;
       accum[section][id].sources.push(pageData);
-      // nav item ordering
-      if (sortValue) {
-        accum[section][id].sortValue = sortValue;
-      }
     }
 
     return accum;
@@ -88,6 +73,7 @@ const sourceOrder = {
   'design-guidelines': 99,
   'accessibility': 100
 };
+const defaultOrder = 50;
 
 const sortSources = ({ source: s1 }, { source: s2 }) => {
   const s1Index = sourceOrder[s1] || defaultOrder;
@@ -122,8 +108,7 @@ Object.entries(groupedRoutes)
       // Loop through each page in expandable subsection
       if (pageData.isSubsection) {
         Object.entries(pageData).map(([section, ids]) => {
-          // only push nested page objects
-          if (ids && ids?.id) {
+          if (section !== 'isSubsection') {
             pageDataArr.push(ids);
           }
         })

package/scripts/cli/build.js

@@ -50,6 +50,11 @@ async function execFile(file, args) {
     const child_execArgv = [
       '--max-old-space-size=4096'
     ];
+
+    if (args.legacySSL) {
+      child_execArgv.push('--openssl-legacy-provider')
+    }
+
     const child = fork(path.join(__dirname, file), child_argv, { execArgv: child_execArgv });
     function errorHandler(err) {
       console.error(err);
@@ -78,6 +83,7 @@ async function build(cmd, options) {
   const config = getConfig(options);
   config.analyze = options.analyze;
   config.output = options.output;
+  config.legacySSL = options.legacySSL
 
   // These get passed to `fork`ed builds
   process.env.pathPrefix = config.pathPrefix;

package/scripts/cli/cli.js

@@ -26,6 +26,7 @@ program
   .command('build <server|client|all>')
   .option('-a, --analyze', 'use webpack-bundle-analyzer', false)
   .option('-o, --output <folder>', 'output folder', 'public')
+  .option('--legacySSL', 'use legacy version of openssl, needed to support Node 18 until we upgrade webpack to v5', false)
   .description('generates source files and runs webpack')
   .action((cmd, options) => {
     const { build } = require('./build');

package/scripts/md/parseMD.js

@@ -85,7 +85,6 @@ function toReactComponent(mdFilePath, source, buildMode) {
         section: frontmatter.section || '',
         subsection: frontmatter.subsection || '',
         source,
-        tabName: frontmatter.tabName || null,
         slug,
         sourceLink: frontmatter.sourceLink || `https://github.com/patternfly/${
           sourceRepo}/blob/main/${
@@ -127,12 +126,6 @@ function toReactComponent(mdFilePath, source, buildMode) {
       if (frontmatter.hideNavItem) {
         pageData.hideNavItem = frontmatter.hideNavItem;
       }
-      if (frontmatter.sortValue) {
-        pageData.sortValue = frontmatter.sortValue;
-      }
-      if (frontmatter.subsectionSortValue) {
-        pageData.subsectionSortValue = frontmatter.subsectionSortValue;
-      }
     })
     // Delete HTML comments
     .use(require('./remove-comments'))
@@ -273,11 +266,8 @@ function sourceMDFile(file, source, buildMode) {
       section: pageData.section,
       subsection: pageData.subsection,
       source: pageData.source,
-      tabName: pageData.tabName,
       ...(pageData.katacodaLayout && { katacodaLayout: pageData.katacodaLayout }),
-      ...(pageData.hideNavItem && { hideNavItem: pageData.hideNavItem }),
-      ...(pageData.sortValue && { sortValue: pageData.sortValue }),
-      ...(pageData.subsectionSortValue && { subsectionSortValue: pageData.subsectionSortValue })
+      ...(pageData.hideNavItem && { hideNavItem: pageData.hideNavItem })
     };
   }
 }

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

@@ -8,7 +8,6 @@ module.exports = (_env, argv) => {
   const {
     pathPrefix = '',
     mode,
-    googleAnalyticsID = false,
     algolia = {},
     hasGdprBanner = false,
     hasFooter = false,
@@ -40,12 +39,9 @@ module.exports = (_env, argv) => {
           include: [
             path.resolve(process.cwd(), 'src'),
             path.resolve(process.cwd(), 'patternfly-docs'),
-            path.resolve(process.cwd(), 'examples'),
             path.resolve(__dirname, '../..'), // Temporarily compile theme using webpack for development
             /react-[\w-]+\/src\/.*\/examples/,
             /react-[\w-]+\\src\\.*\\examples/, // fix for Windows
-            /react-[\w-]+\/patternfly-docs\/.*\/examples/, //fixes for extensions
-            /react-[\w-]+\\patternfly-docs\\.*\\examples/,
           ].concat(includePaths.map(path => new RegExp(path))),
           exclude: [
             path.resolve(__dirname, '../../node_modules'), // Temporarily compile theme using webpack for development
@@ -137,7 +133,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),
         'process.env.hasFooter': JSON.stringify(hasFooter),

package/templates/mdx.js

@@ -121,15 +121,7 @@ export const MDXTemplate = ({
   id,
   componentsData
 }) => {
-  // Build obj mapping source names to text displayed on tabs
-  const tabNames = sources.reduce((acc, curSrc) => {
-    const { source, tabName } = curSrc;
-    // use tabName for tab name if present, otherwise default to source
-    const tabLinkText = tabName || capitalize(source.replace('html', 'HTML').replace(/-/g, ' '));
-    acc[source] = tabLinkText;
-    return acc;
-  }, {});
-  const sourceKeys = Object.keys(tabNames);
+  const sourceKeys = sources.map(v => v.source);
   const isSinglePage = sourceKeys.length === 1;
 
   let isDevResources, isComponent, isExtension, isChart, isDemo, isLayout, isUtility;
@@ -231,7 +223,7 @@ export const MDXTemplate = ({
                       onClick={() => trackEvent('tab_click', 'click_event', source.toUpperCase())}
                     >
                       <Link className="pf-c-tabs__link" to={`${path}${index === 0 ? '' : '/' + source}`}>
-                        {tabNames[source]}
+                        {capitalize(source.replace('html', 'HTML').replace(/-/g, ' '))}
                       </Link>
                     </li>
                   ))}

package/templates/patternfly-docs/content/extensions/extension/design-guidelines/design-guidelines.md

@@ -7,8 +7,6 @@ section: extensions
 id: My extension
 # Tab (react | react-demos | html | html-demos | design-guidelines | accessibility)
 source: design-guidelines
-# Optional custom text to display in tab in place of source
-tabName: My custom tab-name
 ---
 
 Design guidelines intro

package/templates/patternfly-docs/content/extensions/extension/examples/basic.md

@@ -7,8 +7,6 @@ section: extensions
 id: My extension
 # Tab (react | react-demos | html | html-demos | design-guidelines | accessibility)
 source: react
-# Optional custom text to display in tab in place of source
-tabName: My custom tab-name
 # If you use typescript, the name of the interface to display props for
 # These are found through the sourceProps function provdided in patternfly-docs.source.js
 # Can also pass object { component: string, source: string } allowing to specify the source

package/versions.json

@@ -1,5 +1,26 @@
 {
   "Releases": [
+    {
+      "name": "alphas",
+      "date": "2022-02-08",
+      "latest": true,
+      "versions": {
+        "@patternfly/patternfly": "5.0.0-alpha.13",
+        "@patternfly/react-catalog-view-extension": "4.95.1",
+        "@patternfly/react-charts": "7.0.0-alpha.3",
+        "@patternfly/react-code-editor": "5.0.0-alpha.7",
+        "@patternfly/react-core": "5.0.0-alpha.7",
+        "@patternfly/react-drag-drop": "5.0.0-alpha.0",
+        "@patternfly/react-icons": "5.0.0-alpha.2",
+        "@patternfly/react-inline-edit-extension": "4.86.118",
+        "@patternfly/react-log-viewer": "4.87.100",
+        "@patternfly/react-styles": "5.0.0-alpha.2",
+        "@patternfly/react-table": "5.0.0-alpha.7",
+        "@patternfly/react-tokens": "5.0.0-alpha.2",
+        "@patternfly/react-topology": "4.91.27",
+        "@patternfly/react-virtualized-extension": "4.88.113"
+      }
+    },
     {
       "name": "2023.01",
       "date": "2022-01-31",