@patternfly/documentation-framework 5.6.0 → 5.8.0

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# 5.8.0 (2024-03-20)
+
+
+### Features
+
+* **templates:** add templates package to versions.json ([#3902](https://github.com/patternfly/patternfly-org/issues/3902)) ([c7c727c](https://github.com/patternfly/patternfly-org/commit/c7c727c717d5cc3c031f4f3c52070ffc6164e5d6))
+
+
+
+
+
+# 5.7.0 (2024-03-19)
+
+
+### Features
+
+* add pf 6 alpha banner to home page and version switcher ([#3896](https://github.com/patternfly/patternfly-org/issues/3896)) ([f7aaa22](https://github.com/patternfly/patternfly-org/commit/f7aaa22d12310aa62533de4169e1fa70a49a20d9))
+
+
+
+
+
 # 5.6.0 (2024-03-13)
 
 

package/layouts/sideNavLayout/sideNavLayout.js

@@ -163,12 +163,26 @@ const HeaderTools = ({
                     </DropdownList>
                   </DropdownGroup>
                 )}
-                <Divider key="divider" className="ws-switcher-divider"/>
+                <Divider key="divider1" className="ws-switcher-divider"/>
+                <DropdownGroup key="Alpha preview version" label="Alpha preview version">
+                  <DropdownList>
+                    <DropdownItem
+                      key="PatternFly 6"
+                      className="ws-patternfly-versions"
+                      isExternalLink
+                      to="https://staging-v6.patternfly.org/"
+                      itemId="patternfly-6"
+                    >
+                      PatternFly 6
+                    </DropdownItem>
+                  </DropdownList>
+                </DropdownGroup>
+                <Divider key="divider2" className="ws-switcher-divider"/>
                 <DropdownGroup key="Previous versions" label="Previous versions">
                   <DropdownList>
                     <DropdownItem
                       key="PatternFly 4"
-                      className="ws-patternfly-3"
+                      className="ws-patternfly-versions"
                       isExternalLink
                       to="http://v4-archive.patternfly.org/v4/"
                       itemId="patternfly-4"
@@ -177,7 +191,7 @@ const HeaderTools = ({
                     </DropdownItem>
                     <DropdownItem
                       key="PatternFly 3"
-                      className="ws-patternfly-3"
+                      className="ws-patternfly-versions"
                       isExternalLink
                       to="https://pf3.patternfly.org/"
                       itemId="patternfly-3"

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@patternfly/documentation-framework",
   "description": "A framework to build documentation for PatternFly.",
-  "version": "5.6.0",
+  "version": "5.8.0",
   "author": "Red Hat",
   "license": "MIT",
   "private": false,
@@ -17,7 +17,7 @@
     "@babel/plugin-transform-react-jsx": "7.17.12",
     "@babel/preset-env": "7.18.2",
     "@mdx-js/util": "1.6.16",
-    "@patternfly/ast-helpers": "^1.6.0",
+    "@patternfly/ast-helpers": "^1.8.0",
     "@reach/router": "npm:@gatsbyjs/reach-router@1.3.9",
     "autoprefixer": "9.8.6",
     "babel-loader": "9.1.2",
@@ -84,5 +84,5 @@
     "react": "^17.0.0 || ^18.0.0",
     "react-dom": "^17.0.0 || ^18.0.0"
   },
-  "gitHead": "26de940cd895bddf7986df1771900d63b5d1c196"
+  "gitHead": "861632d3959c8dc2809dd6b76b4e3c69718f7a8b"
 }

package/scripts/md/parseMD.js

@@ -105,6 +105,7 @@ function toReactComponent(mdFilePath, source, buildMode) {
         section: frontmatter.section || '',
         subsection: frontmatter.subsection || '',
         deprecated: frontmatter.deprecated || false,
+        template: frontmatter.template || false,
         beta: frontmatter.beta || false,
         demo: frontmatter.demo || false,
         newImplementationLink: frontmatter.newImplementationLink || false,
@@ -295,6 +296,7 @@ function sourceMDFile(file, source, buildMode) {
       ...(pageData.hideNavItem && { hideNavItem: pageData.hideNavItem }),
       ...(pageData.beta && { beta: pageData.beta }),
       ...(pageData.deprecated && { deprecated: pageData.deprecated }),
+      ...(pageData.template && { template: pageData.template }),
       ...(pageData.demo && { demo: pageData.demo }),
       ...(pageData.sortValue && { sortValue: pageData.sortValue }),
       ...(pageData.subsectionSortValue && { subsectionSortValue: pageData.subsectionSortValue })

package/templates/mdx.css

@@ -1,7 +1,7 @@
 #ws-page-content-router {
   display: flex;
   flex-direction: column;
-  height: 100%;
+  flex-shrink: 0;
 }
 
 .ws-release-notes-toc {

package/templates/mdx.js

@@ -23,6 +23,7 @@ const MDXChildTemplate = ({
     optIn,
     beta,
     deprecated,
+    template,
     newImplementationLink,
     functionDocumentation = []
   } = Component.getPageData();
@@ -84,6 +85,11 @@ const MDXChildTemplate = ({
           {' '}To learn more about the process, visit our <Link to="/get-started/about#major-release-cadence">about page</Link>.
         </InlineAlert>
       )}
+       {(template || source === 'react-template') && (
+        <InlineAlert title="Templates" variant="info">
+          {`This page showcases templates for the ${id.toLowerCase()} component. A template combines a component with logic that supports a specific use case, with a streamlined API that offers additional, limited customization.`}
+        </InlineAlert>
+      )}
     </React.Fragment>
   );
   // Create dynamic component for @reach/router

package/versions.json

@@ -21,7 +21,8 @@
         "@patternfly/react-topology": "5.2.1",
         "@patternfly/react-user-feedback": "5.0.0",
         "@patternfly/react-virtualized-extension": "5.0.0",
-        "@patternfly/quickstarts": "5.0.0"
+        "@patternfly/quickstarts": "5.0.0",
+        "@patternfly/react-templates": "^1.0.0-alpha.0"
       }
     },
     {
@@ -45,7 +46,8 @@
         "@patternfly/react-topology": "5.2.1",
         "@patternfly/react-user-feedback": "5.0.0",
         "@patternfly/react-virtualized-extension": "5.0.0",
-        "@patternfly/quickstarts": "5.0.0"
+        "@patternfly/quickstarts": "5.0.0",
+        "@patternfly/react-templates": "^1.0.0-alpha.0"
       }
     },
     {
@@ -69,7 +71,8 @@
         "@patternfly/react-topology": "5.2.1",
         "@patternfly/react-user-feedback": "5.0.0",
         "@patternfly/react-virtualized-extension": "5.0.0",
-        "@patternfly/quickstarts": "5.0.0"
+        "@patternfly/quickstarts": "5.0.0",
+        "@patternfly/react-templates": "^1.0.0-alpha.0"
       }
     },{
       "name": "5.1.0",