feat(templates): add templates package to versions.json (patternfly#3902

) * feat(templates): add templates package to versions.json for docs build * add support for template inline alert * add to patch version, update wording * update wording
nicolethoen · Mar 22, 2024 · 998683f · 998683f
1 parent 370bf03
commit 998683f
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 3 deletions.
diff --git a/packages/documentation-framework/scripts/md/parseMD.js b/packages/documentation-framework/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 })

diff --git a/packages/documentation-framework/templates/mdx.js b/packages/documentation-framework/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

diff --git a/packages/documentation-framework/versions.json b/packages/documentation-framework/versions.json
@@ -41,7 +41,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"
       }
     },
     {
@@ -65,7 +66,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"
       }
     },
     {
@@ -89,7 +91,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",