@patternfly/documentation-framework 6.0.0-alpha.80 → 6.0.0-alpha.82

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# 6.0.0-alpha.82 (2024-08-20)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 6.0.0-alpha.81 (2024-08-20)
+
+
+### Bug Fixes
+
+* **docs:** removed extra link tags in card title ([#4166](https://github.com/patternfly/patternfly-org/issues/4166)) ([e9a0f3e](https://github.com/patternfly/patternfly-org/commit/e9a0f3e4e79e145af6880d8dd204bf65bcb20125))
+
+
+
+
+
 # 6.0.0-alpha.80 (2024-08-20)
 
 

package/README.md

@@ -16,53 +16,15 @@ We publish this theme [on npm.](https://www.npmjs.com/package/@patternfly/docume
 
 2. Provide or install the following either as dependencies if you want to use them in your own project, or as devDependencies:
     ```
-    "@patternfly/patternfly": "^4.185.1",
-    "@patternfly/react-core": "^4.202.16",
-    "@patternfly/react-table": "^4.71.16",
-    "@patternfly/react-code-editor": "^4.43.16",
+    "@patternfly/patternfly": "6.0.0-alpha.205",
+    "@patternfly/react-core": "6.0.0-alpha.94",
+    "@patternfly/react-table": "6.0.0-alpha.95",
+    "@patternfly/react-code-editor": "6.0.0-alpha.94",
     ```
     `yarn add -D @patternfly/patternfly @patternfly/react-core @patternfly/react-table @patternfly/react-code-editor`
 
-### Resolutions
-
-This should not be needed, but if you encounter errors installing the above devDependencies, try adding one or more of these resolutions to your package.json file:
-```
-"resolutions": {
-  "@types/react": "^16.8.0",
-  "@types/react-dom": "^16.8.0",
-  "react": "16.8.0",
-  "react-dom": "16.8.0",
-  "chromedriver": "102.0.0",
-  "node-sass": "7.0.1",
-  "puppeteer": "14.3.0",
-  "sharp": "0.30.6"
-}
-```
-
 ## First time setup
 
-### Puppeteer
-
-Puppeteer is used to create screenshots, it requires chromium to be installed on your machine
-
-- install chromium using brew:
-
-  `brew install chromium`
-- check the chromium path, should point to /opt/homebrew/bin/chromium:
-
-  `which chromium`
-- export out the path:
-
-  export PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true
-
-  export PUPPETEER_EXECUTABLE_PATH=\`which chromium\`
-
-- So you don't have to retype this in the future, save to your shell rc file like .bashrc or .zshrc:
-
-  echo 'export PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true' >> ~/.zshrc
-
-  echo 'export PUPPETEER_EXECUTABLE_PATH=\`which chromium\`' >> ~/.zshrc 
-
 ### Init documentation project
 
 To get started, you can scaffold out a sample extension docs setup:
@@ -81,48 +43,15 @@ For individual CLI commands, you can also display more information by running `n
 
 ### Develop docs
 
-`yarn docs:develop`
-
-or
-
 `npx pf-docs-framework start`
 
 ### Build docs
 
-`yarn docs:build`
-
-or
-
 `npx pf-docs-framework build all --output public`
 
 > NOTE: If you have `sideEffects: false` in your package.json, that will prevent the CSS from loading in the documentation production build. Set it to true or remove it to enable the CSS from being loaded.
 
-### Generate screenshots
-
-You can generate screenshots against development or production builds.
-
-- Development:
-
-  Terminal 1:
-
-  `yarn docs:develop` or `npx pf-docs-framework start` (Take note of the port it started on, you can modify it in patternfly-docs.config)
-
-  Terminal 2:
-
-  `yarn docs:screenshots` or `npx pf-docs-framework screenshots --urlPrefix http://localhost:<PORT>`
-
-- Production:
-
-  Terminal 1:
-  
-  - `yarn docs:build` or `npx pf-docs-framework build all --output public`
-  - `yarn docs:serve` or `npx pf-docs-framework serve public --port 5000`
-
-  Terminal 2:
-
-  `yarn docs:screenshots` or `npx pf-docs-framework screenshots --urlPrefix http://localhost:5000`
-
-  ### Publish docs to patternfly.org
+### Publish docs to patternfly.org
 
   1. Include the `patternfly-docs/content` and `patternfly-docs/generated` folders as part of your npm published module
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@patternfly/documentation-framework",
   "description": "A framework to build documentation for PatternFly.",
-  "version": "6.0.0-alpha.80",
+  "version": "6.0.0-alpha.82",
   "author": "Red Hat",
   "license": "MIT",
   "private": false,
@@ -13,7 +13,7 @@
     "@babel/preset-env": "^7.24.3",
     "@babel/preset-react": "^7.24.1",
     "@mdx-js/util": "1.6.16",
-    "@patternfly/ast-helpers": "^1.4.0-alpha.69",
+    "@patternfly/ast-helpers": "^1.4.0-alpha.71",
     "@reach/router": "npm:@gatsbyjs/reach-router@1.3.9",
     "autoprefixer": "9.8.6",
     "babel-loader": "^9.1.3",
@@ -73,12 +73,12 @@
     "webpack-merge": "5.8.0"
   },
   "peerDependencies": {
-    "@patternfly/patternfly": "6.0.0-alpha.205",
-    "@patternfly/react-code-editor": "6.0.0-alpha.100",
-    "@patternfly/react-core": "6.0.0-alpha.100",
-    "@patternfly/react-table": "6.0.0-alpha.101",
+    "@patternfly/patternfly": "6.0.0-alpha.210",
+    "@patternfly/react-code-editor": "6.0.0-alpha.101",
+    "@patternfly/react-core": "6.0.0-alpha.101",
+    "@patternfly/react-table": "6.0.0-alpha.102",
     "react": "^17.0.0 || ^18.0.0",
     "react-dom": "^17.0.0 || ^18.0.0"
   },
-  "gitHead": "6144cce4fc10aee15889007a5d569e448dba3768"
+  "gitHead": "1821f97b6ff05bdfb4f8552921ce72ef51f382f1"
 }