@patternfly/documentation-framework 1.8.0 → 2.0.0-alpha.1

package/CHANGELOG.md

@@ -3,31 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# 1.8.0 (2023-02-09)
+# 2.0.0-alpha.1 (2023-02-13)
 
 
 ### 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))
-
-
-
-
-
-# 1.7.0 (2023-02-09)
-
-
-### 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))
-
-
-
-
-
-## 1.6.1 (2023-02-09)
-
-**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/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/package.json

@@ -1,10 +1,14 @@
 {
   "name": "@patternfly/documentation-framework",
   "description": "A framework to build documentation for PatternFly.",
-  "version": "1.8.0",
+  "version": "2.0.0-alpha.1",
   "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": "473ad9370d5a4d48fdfe1c061e723a0911f3ac33"
+  "gitHead": "b9ec67db0e229b808ea53376209393c25b3e1869"
 }

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/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/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,25 @@
 {
   "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-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",