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

package/CHANGELOG.md

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

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

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/${
@@ -267,7 +266,6 @@ 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 })
     };

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",