@patternfly/documentation-framework 2.0.0-alpha.20 → 2.0.0-alpha.21

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# 2.0.0-alpha.21 (2023-04-15)
+
+
+### Bug Fixes
+
+* clean up references to katacoda ([#3491](https://github.com/patternfly/patternfly-org/issues/3491)) ([5de986b](https://github.com/patternfly/patternfly-org/commit/5de986b917ee7edf9c476bb2df2f2ee4d454a7e1))
+
+
+
+
+
 # 2.0.0-alpha.20 (2023-04-14)
 
 **Note:** Version bump only for package @patternfly/documentation-framework

package/app.js

@@ -16,7 +16,7 @@ import './components/sideNav/sideNav.css';
 import './components/topNav/topNav.css';
 import './layouts/sideNavLayout/sideNavLayout.css';
 
-const AppRoute = ({ child, katacodaLayout, title, path }) => {
+const AppRoute = ({ child, title, path }) => {
   const pathname = useLocation().pathname;
   if (typeof window !== 'undefined' && window.gtag) {
     gtag('config', process.env.googleAnalyticsID, {
@@ -31,7 +31,7 @@ const AppRoute = ({ child, katacodaLayout, title, path }) => {
   return (
     <React.Fragment>
       {child}
-      {!katacodaLayout && process.env.hasFooter && <Footer />}
+      {process.env.hasFooter && <Footer />}
     </React.Fragment>
   );
 }
@@ -39,18 +39,17 @@ const AppRoute = ({ child, katacodaLayout, title, path }) => {
 const SideNavRouter = () => {
   const pathname = useLocation().pathname.replace(process.env.pathPrefix, '');
   const componentsData = process?.env?.componentsData;
-  const navOpen = !routes[pathname] || !routes[pathname].katacodaLayout;
+  const navOpen = !routes[pathname];
   return (
     <SideNavLayout groupedRoutes={groupedRoutes} navOpen={navOpen} >
       <Router id="ws-page-content-router">
         {Object.entries(routes)
-          .map(([path, { Component, title, sources, katacodaLayout, id }]) => Component
+          .map(([path, { Component, title, sources, id }]) => Component
             ? <AppRoute
                 key={path}
                 path={path}
                 default={path === '/404'}
                 child={<Component />}
-                katacodaLayout={katacodaLayout}
                 title={title}
               />
             : <AppRoute
@@ -65,7 +64,6 @@ const SideNavRouter = () => {
                     componentsData={componentsData}
                   />
                 }
-                katacodaLayout={katacodaLayout}
                 title={title}
               />
           )

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@patternfly/documentation-framework",
   "description": "A framework to build documentation for PatternFly.",
-  "version": "2.0.0-alpha.20",
+  "version": "2.0.0-alpha.21",
   "author": "Red Hat",
   "license": "MIT",
   "private": false,
@@ -89,5 +89,5 @@
     "react": "^17.0.0 || ^18.0.0",
     "react-dom": "^17.0.0 || ^18.0.0"
   },
-  "gitHead": "421584878eaf3a8b4bce4f8ac45238c6b2c3557c"
+  "gitHead": "527165f722646aff84364fd888e6c676da746a77"
 }

package/routes.js

@@ -30,7 +30,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, hideNavItem, relPath, sortValue = null, subsectionSortValue = null } = pageData;
     pageData.slug = slug;
     // add section to groupedRoutes obj if not yet created
     accum[section] = accum[section] || {};
@@ -42,7 +42,6 @@ const groupedRoutes = Object.entries(routes)
       title,
       slug: makeSlug(source, section, id, true, subsection),
       sources: [],
-      katacodaLayout,
       hideNavItem,
       relPath,
       ...(sortValue && { sortValue }),

package/scripts/md/parseMD.js

@@ -118,12 +118,6 @@ function toReactComponent(mdFilePath, source, buildMode) {
           ? frontmatter.cssPrefix
           : [frontmatter.cssPrefix];
       }
-      if (frontmatter.katacodaBroken) {
-        pageData.katacodaBroken = frontmatter.katacodaBroken;
-      }
-      if (frontmatter.katacodaLayout) {
-        pageData.katacodaLayout = frontmatter.katacodaLayout;
-      }
       if (frontmatter.hideNavItem) {
         pageData.hideNavItem = frontmatter.hideNavItem;
       }
@@ -274,7 +268,6 @@ function sourceMDFile(file, source, buildMode) {
       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 })

package/templates/mdx.css

@@ -297,11 +297,6 @@
   max-width: 832px;
 }
 
-.ws-mdx-content-katacoda {
-  flex-grow: 1;
-  padding: 0;
-}
-
 /* Overlay the footer */
 .ws-back-to-top {
   z-index: 2;

package/templates/mdx.js

@@ -19,9 +19,7 @@ const MDXChildTemplate = ({
     sourceLink,
     cssPrefix = [],
     optIn,
-    beta,
-    katacodaBroken,
-    katacodaLayout
+    beta
   } = Component.getPageData();
   const cssVarsTitle = cssPrefix.length > 0 && 'CSS variables';
   const propsTitle = propComponents.length > 0 && 'Props';
@@ -59,11 +57,6 @@ const MDXChildTemplate = ({
           To learn more about the process, visit our <Link to="/get-started/about#beta-components">about page</Link> or our <a href="https://github.com/patternfly/patternfly-org/tree/main/beta-component-promotion">Beta components</a> page on GitHub.
         </InlineAlert>
       )}
-      {katacodaBroken && (
-        <InlineAlert variant="warning" title="Down for maintenance">
-          The embedded version of our tutorials are broken, but you can still access our tutorials on <a href="https://www.katacoda.com/patternfly">Katacoda.com <ExternalLinkAltIcon /></a>.
-        </InlineAlert>
-      )}
     </React.Fragment>
   );
   // Create dynamic component for @reach/router
@@ -72,8 +65,8 @@ const MDXChildTemplate = ({
       {toc.length > 1 && (
         <TableOfContents items={toc} />
       )}
-      <div className={katacodaLayout? "ws-mdx-content-katacoda" : "ws-mdx-content"}>
-        <div className={katacodaLayout ? "" : "ws-mdx-content-content"}>
+      <div className="ws-mdx-content">
+        <div className="ws-mdx-content-content">
           {InlineAlerts}
           <Component />
           {propsTitle && (
@@ -100,7 +93,7 @@ const MDXChildTemplate = ({
               <CSSVariables prefix={cssPrefix} />
             </React.Fragment>
           )}
-          {!katacodaLayout && sourceLink && (
+          {sourceLink && (
             <React.Fragment>
               <br />
               <a href={sourceLink} target="_blank" onClick={() => trackEvent('view_source_click', 'click_event', source.toUpperCase())}>View source on GitHub</a>
@@ -167,7 +160,6 @@ export const MDXTemplate = ({
     (e) => e.includes("pages") || e.includes("training")
   );
   const { pathname } = useLocation();
-  const { katacodaLayout } = sources[0].Component.getPageData();
   let activeSource = pathname.replace(/\/$/, '').split('/').pop();
   // get summary text, convert to JSX to display above tabs on component pages
   const componentDasherized = id.split(' ').join('-').toLowerCase();
@@ -209,7 +201,7 @@ export const MDXTemplate = ({
           isWidthLimited
         >
           <TextContent>
-          {!katacodaLayout && <Title headingLevel='h1' size='4xl' id="ws-page-title">{title}</Title>}
+          <Title headingLevel='h1' size='4xl' id="ws-page-title">{title}</Title>
           {isComponent && summary && (<SummaryComponent />)}
           </TextContent>
         </PageSection>