@patternfly/documentation-framework 2.0.0-alpha.8 → 5.0.1

package/CHANGELOG.md

@@ -3,6 +3,623 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## 5.0.1 (2023-06-23)
+
+
+### Bug Fixes
+
+* turn dry run off ([#3627](https://github.com/patternfly/patternfly-org/issues/3627)) ([f0a2d51](https://github.com/patternfly/patternfly-org/commit/f0a2d510b75b69b18cdbbd7ceb663241ef30093f))
+
+
+
+
+
+# 2.0.0-alpha.74 (2023-06-23)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.73 (2023-06-23)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.72 (2023-06-22)
+
+
+### Bug Fixes
+
+* **deps:** update docs-framework to the latest prereleases ([#3615](https://github.com/patternfly/patternfly-org/issues/3615)) ([54091c3](https://github.com/patternfly/patternfly-org/commit/54091c358f01f65269f314c2717ad58767aa669a))
+
+
+
+
+
+# 2.0.0-alpha.71 (2023-06-22)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.70 (2023-06-22)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.69 (2023-06-22)
+
+
+### Bug Fixes
+
+* **docs:** fixed broken css vars header link ([#3617](https://github.com/patternfly/patternfly-org/issues/3617)) ([ad2b012](https://github.com/patternfly/patternfly-org/commit/ad2b01252d68cf8c4e53fac283b142b13994b222))
+
+
+
+
+
+# 2.0.0-alpha.68 (2023-06-21)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.67 (2023-06-21)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.66 (2023-06-16)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.65 (2023-06-15)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.64 (2023-06-15)
+
+
+### Bug Fixes
+
+* **Sidenav:** updated PageContext props ([#3593](https://github.com/patternfly/patternfly-org/issues/3593)) ([1cc24ea](https://github.com/patternfly/patternfly-org/commit/1cc24ea1ef88c42a6b62a4a6b2421d157bc298d8))
+
+
+
+
+
+# 2.0.0-alpha.63 (2023-06-14)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.62 (2023-06-14)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.61 (2023-06-14)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.60 (2023-06-13)
+
+
+### Bug Fixes
+
+* **docs:** fixed gallery styles affecting width, font vars ([#3596](https://github.com/patternfly/patternfly-org/issues/3596)) ([04f1b54](https://github.com/patternfly/patternfly-org/commit/04f1b54f947e1afca88926d8f371d3bf37a70e25))
+
+
+
+
+
+# 2.0.0-alpha.59 (2023-06-13)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.58 (2023-06-13)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.57 (2023-06-12)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.56 (2023-06-12)
+
+
+### Features
+
+* turn on dark switcher, remove extra css ([#3519](https://github.com/patternfly/patternfly-org/issues/3519)) ([0059891](https://github.com/patternfly/patternfly-org/commit/005989134d6a962189690a49faccb8dfc6e3de77))
+
+
+
+
+
+# 2.0.0-alpha.55 (2023-06-12)
+
+
+### Bug Fixes
+
+* **whitespace:** whitespace change to push out new release ([84d1bb3](https://github.com/patternfly/patternfly-org/commit/84d1bb3ccc79a9ef2c4cf5fb93b19fbb719b6078))
+
+
+
+
+
+# 2.0.0-alpha.54 (2023-06-09)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.53 (2023-06-09)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.52 (2023-06-07)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.51 (2023-06-06)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.50 (2023-06-01)
+
+
+### Bug Fixes
+
+* **labels:** Update label logic to include html components ([#3567](https://github.com/patternfly/patternfly-org/issues/3567)) ([32bdc0f](https://github.com/patternfly/patternfly-org/commit/32bdc0fe2120e2c86f39c1e5da94e3f2d11d9705))
+
+
+
+
+
+# 2.0.0-alpha.49 (2023-06-01)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.48 (2023-05-31)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.47 (2023-05-31)
+
+
+### Bug Fixes
+
+* **CSSVariables:** check for values before looping over them ([f2d167f](https://github.com/patternfly/patternfly-org/commit/f2d167f57c0cd38b289ade62d98022d7902de38f))
+
+
+
+
+
+# 2.0.0-alpha.46 (2023-05-31)
+
+
+### Bug Fixes
+
+* **CSSVariables:** resolve a11y issues in tables ([41a7837](https://github.com/patternfly/patternfly-org/commit/41a78379de36c08d7b36fe48a9ff40a4140cdc63))
+
+
+
+
+
+# 2.0.0-alpha.45 (2023-05-25)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.44 (2023-05-25)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.43 (2023-05-25)
+
+
+### Features
+
+* **labels:** add deprecated/demo/beta labels to headers + nav items ([#3547](https://github.com/patternfly/patternfly-org/issues/3547)) ([010a0e0](https://github.com/patternfly/patternfly-org/commit/010a0e05baea661964660d2a733569a34abbf243))
+
+
+
+
+
+# 2.0.0-alpha.42 (2023-05-18)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.41 (2023-05-15)
+
+
+### Bug Fixes
+
+* broken link in search-input summary ([7cbf968](https://github.com/patternfly/patternfly-org/commit/7cbf968c1b00aef2257ef8b7434c7ff8b9a4255a))
+
+
+
+
+
+# 2.0.0-alpha.40 (2023-05-15)
+
+
+### Bug Fixes
+
+* **docs:** use correct theme class on full page dark theme switcher ([#3532](https://github.com/patternfly/patternfly-org/issues/3532)) ([0008236](https://github.com/patternfly/patternfly-org/commit/0008236da2b105fd1789db2263323c59780b5194))
+
+
+
+
+
+# 2.0.0-alpha.39 (2023-05-11)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.38 (2023-05-11)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.37 (2023-05-10)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.36 (2023-05-10)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.35 (2023-05-09)
+
+
+### Bug Fixes
+
+* **org:** Fix up org css issues after doc framework update ([#3518](https://github.com/patternfly/patternfly-org/issues/3518)) ([a6f20c5](https://github.com/patternfly/patternfly-org/commit/a6f20c569a8ba8df2da23722c48f73f750e229e3))
+
+
+
+
+
+# 2.0.0-alpha.34 (2023-05-05)
+
+
+### Features
+
+* **docs:** Update docs framework with latest react code ([#3517](https://github.com/patternfly/patternfly-org/issues/3517)) ([2df0147](https://github.com/patternfly/patternfly-org/commit/2df014737dbbe35033d0b28ee71b40d5fbe22ed2))
+
+
+
+
+
+# 2.0.0-alpha.33 (2023-05-04)
+
+
+### Bug Fixes
+
+* **css:** update css selectors for v5 versioning ([#3516](https://github.com/patternfly/patternfly-org/issues/3516)) ([f681945](https://github.com/patternfly/patternfly-org/commit/f681945e2de1200fbb7d2d6ab8262091b1e72a8e))
+
+
+
+
+
+# 2.0.0-alpha.32 (2023-05-02)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.31 (2023-05-01)
+
+
+### Bug Fixes
+
+* update Text component summary to fix build ([64b3590](https://github.com/patternfly/patternfly-org/commit/64b359029fa14be143ddec212fdf89a3033145d5))
+
+
+
+
+
+# 2.0.0-alpha.30 (2023-04-27)
+
+
+### Bug Fixes
+
+* white space change to test CI ([e9e7ed3](https://github.com/patternfly/patternfly-org/commit/e9e7ed3cf6007fcf022dd7693bfed12bdf9d7e9a))
+
+
+
+
+
+# 2.0.0-alpha.29 (2023-04-26)
+
+
+### Bug Fixes
+
+* sidebar open by default ([#3506](https://github.com/patternfly/patternfly-org/issues/3506)) ([fb5f086](https://github.com/patternfly/patternfly-org/commit/fb5f08611d3edde80a559635b39dab7138f06d1d))
+
+
+
+
+
+# 2.0.0-alpha.28 (2023-04-26)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.27 (2023-04-25)
+
+
+### Bug Fixes
+
+* **docs:** Update static dir and fix null loading ([#3505](https://github.com/patternfly/patternfly-org/issues/3505)) ([e65a1b2](https://github.com/patternfly/patternfly-org/commit/e65a1b21ae7671322adcbcef1ada69436fd07802))
+
+
+
+
+
+# 2.0.0-alpha.26 (2023-04-21)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.25 (2023-04-19)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.24 (2023-04-17)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.23 (2023-04-17)
+
+
+### Features
+
+* **docs-framework:** add support for exposing function documentation ([#3485](https://github.com/patternfly/patternfly-org/issues/3485)) ([2f19ded](https://github.com/patternfly/patternfly-org/commit/2f19deda84c75042df1870c0950bb173eb2c3d84))
+
+
+
+
+
+# 2.0.0-alpha.22 (2023-04-17)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 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
+
+
+
+
+
+# 2.0.0-alpha.19 (2023-04-12)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.18 (2023-04-11)
+
+
+### Bug Fixes
+
+* **cssVariables:** Update expandId ([b9b0a6e](https://github.com/patternfly/patternfly-org/commit/b9b0a6edcc103c442f24caae086b68558415be57))
+
+
+
+
+
+# 2.0.0-alpha.17 (2023-04-11)
+
+
+### Bug Fixes
+
+* **docs:** fixes display & search bugs on icons page ([#3483](https://github.com/patternfly/patternfly-org/issues/3483)) ([39b225c](https://github.com/patternfly/patternfly-org/commit/39b225cdcbdc4c01c5002750600708eab6427f60))
+
+
+
+
+
+# 2.0.0-alpha.16 (2023-04-11)
+
+
+### Features
+
+* **tables:** update tables, context selector ([#3474](https://github.com/patternfly/patternfly-org/issues/3474)) ([cd82c35](https://github.com/patternfly/patternfly-org/commit/cd82c356f568f3368bc22319d614fde8dd74fb38))
+
+
+
+
+
+# 2.0.0-alpha.15 (2023-04-06)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.14 (2023-04-03)
+
+
+### Bug Fixes
+
+* **Tables:** temporarily comment out tables so Table can be deprecated ([#3468](https://github.com/patternfly/patternfly-org/issues/3468)) ([f4aa5ed](https://github.com/patternfly/patternfly-org/commit/f4aa5ed791161851cdc92d02d0c752eef4028306))
+
+
+
+
+
+# 2.0.0-alpha.13 (2023-03-31)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.12 (2023-03-30)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.11 (2023-03-29)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.10 (2023-03-15)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.9 (2023-03-09)
+
+
+### Bug Fixes
+
+* **versions:** fix typo ([a9b8fe2](https://github.com/patternfly/patternfly-org/commit/a9b8fe296a9c28bdd9ada01a80b1653810802ddf))
+
+
+
+
+
 # 2.0.0-alpha.8 (2023-03-03)
 
 

package/README.md

@@ -1,6 +1,6 @@
 # @patternfly/documentation-framework
 
-## The PatternFly documentation framework lets you develop component examples in markdown format, so that they can be added to [patternfly.org](https://www.patternfly.org/v4/).
+## The PatternFly documentation framework lets you develop component examples in markdown format, so that they can be added to [patternfly.org](https://www.patternfly.org/).
 
 ## Install
 

package/app.js

@@ -1,5 +1,5 @@
 import React from 'react';
-import ReactDOM from 'react-dom';
+import { createRoot, hydrateRoot } from 'react-dom/client';
 import { Router, useLocation } from '@reach/router';
 import 'client-styles'; // Webpack replaces this import: patternfly-docs.css.js
 import { SideNavLayout } from '@patternfly/documentation-framework/layouts';
@@ -13,17 +13,23 @@ import './components/tableOfContents/tableOfContents.css';
 import './components/example/example.css';
 import './components/footer/footer.css';
 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', 'UA-47523816-6', {
+    gtag('config', process.env.googleAnalyticsID, {
       'page_path': pathname,
       'page_title': (title || pathname)
     });
   }
+
+  // Redirect all v4 url paths to the archived v4 site
+  if(pathname.startsWith("/v4")){
+    window.location.href = `https://v4-archive.patternfly.org${pathname}`;
+    return;
+  }
+
   // Send 404 event if redirected to 404 page
   if (path === '/404' && pathname.split('/').pop() !== '404') {
     trackEvent('404_redirect', 'redirect', pathname);
@@ -31,26 +37,23 @@ const AppRoute = ({ child, katacodaLayout, title, path }) => {
   return (
     <React.Fragment>
       {child}
-      {!katacodaLayout && process.env.hasFooter && <Footer />}
+      {process.env.hasFooter && <Footer />}
     </React.Fragment>
   );
 }
 
 const SideNavRouter = () => {
-  const pathname = useLocation().pathname.replace(process.env.pathPrefix, '');
   const componentsData = process?.env?.componentsData;
-  const navOpen = !routes[pathname] || !routes[pathname].katacodaLayout;
   return (
-    <SideNavLayout groupedRoutes={groupedRoutes} navOpen={navOpen} >
+    <SideNavLayout groupedRoutes={groupedRoutes} navOpen={true} >
       <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 +68,6 @@ const SideNavRouter = () => {
                     componentsData={componentsData}
                   />
                 }
-                katacodaLayout={katacodaLayout}
                 title={title}
               />
           )
@@ -87,7 +89,7 @@ const FullscreenComponent = ({ Component, title }) => {
 
 // Export for SSR
 export const App = () => (
-  <Router basepath={process.env.pathPrefix} id="ws-router">
+  <Router id="ws-router">
     <SideNavRouter path="/*" />
     {Object.entries(fullscreenRoutes)
       .map(([path, { title, Component }]) =>
@@ -107,8 +109,12 @@ const isPrerender = process.env.PRERENDER;
 // Don't use ReactDOM in SSR
 if (!isPrerender) {
   function render() {
-    const renderFn = isProd ? ReactDOM.hydrate : ReactDOM.render;
-    renderFn(<App />, document.getElementById('root'));
+    const container = document.getElementById('root');
+    if (isProd) {
+        hydrateRoot(container, <App />);
+    } else {
+        createRoot(container).render(<App />);
+    }
   }
   // On first load, await promise for the current page to avoid flashing a "Loading..." state
   const Component = getAsyncComponent(null);