@patternfly/documentation-framework 1.0.3-rc1 → 1.0.5

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## 1.0.5 (2022-07-06)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
 # 0.12.0 (2022-07-05)
 
 

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Red Hat, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,12 +1,43 @@
 # @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/).
+
 ## Install
 
 We publish this theme [on npm.](https://www.npmjs.com/package/@patternfly/documentation-framework) Install it as a devDependency with your package manager.
 
-`npm i --save-dev @patternfly/documentation-framework`
+1. @patternfly/documentation-framework
+
+    `npm i --save-dev @patternfly/documentation-framework`
+
+    or
+
+    `yarn add -D @patternfly/documentation-framework`
+
+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",
+    ```
+    `yarn add -D @patternfly/patternfly @patternfly/react-core @patternfly/react-table @patternfly/react-code-editor`
 
-`yarn add -D @patternfly/documentation-framework`
+### 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
 
@@ -89,4 +120,10 @@ You can generate screenshots against development or production builds.
 
   Terminal 2:
 
-  `yarn docs:screenshots` or `npx pf-docs-framework screenshots --urlPrefix http://localhost:5000`
+  `yarn docs:screenshots` or `npx pf-docs-framework screenshots --urlPrefix http://localhost:5000`
+
+  ### Publish docs to patternfly.org
+
+  1. Include the `patternfly-docs/content` and `patternfly-docs/generated` folders as part of your npm published module
+
+  2. Create a PR at [patternfly-org](https://github.com/patternfly/patternfly-org) to bundle in the package's examples so that they're part of the patternfly.org documentation.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@patternfly/documentation-framework",
   "description": "A framework to build documentation for PatternFly.",
-  "version": "1.0.3-rc1",
+  "version": "1.0.5",
   "author": "Red Hat",
   "license": "MIT",
   "private": false,
@@ -28,9 +28,12 @@
     "copy-webpack-plugin": "6.1.0",
     "css-loader": "4.3.0",
     "detab": "2.0.3",
+    "express": "4.18.1",
     "file-loader": "6.1.0",
     "file-saver": "1.3.8",
     "fs-extra": "9.0.1",
+    "glob": "8.0.3",
+    "handlebars": "4.7.7",
     "hast-to-hyperscript": "9.0.0",
     "hast-util-to-text": "2.0.0",
     "html-formatter": "0.1.9",
@@ -43,6 +46,7 @@
     "monaco-editor": "0.21.3",
     "monaco-editor-webpack-plugin": "2.1.0",
     "null-loader": "4.0.0",
+    "parse-entities": "2.0.0",
     "postcss": "7.0.32",
     "postcss-loader": "4.2.0",
     "puppeteer": "14.3.0",
@@ -70,18 +74,15 @@
     "webpack-bundle-analyzer": "3.8.0",
     "webpack-cli": "3.3.12",
     "webpack-dev-server": "3.11.0",
-    "webpack-merge": "5.8.0",
-    "parse-entities": "2.0.0",
-    "glob": "8.0.3",
-    "express": "4.18.1",
-    "handlebars": "4.7.7"
+    "webpack-merge": "5.8.0"
   },
   "peerDependencies": {
-    "react": "^16.8.0 || ^17.0.0",
-    "react-dom": "^16.8.0 || ^17.0.0",
     "@patternfly/patternfly": ">=4.185.1",
-    "@patternfly/react-core": ">=4.202.16",
     "@patternfly/react-code-editor": ">=4.43.16",
-    "@patternfly/react-table": ">=4.71.16"
-  }
+    "@patternfly/react-core": ">=4.202.16",
+    "@patternfly/react-table": ">=4.71.16",
+    "react": "^16.8.0 || ^17.0.0",
+    "react-dom": "^16.8.0 || ^17.0.0"
+  },
+  "gitHead": "9380bcb7a683ec4758f5ac144f214f26a63c0d0f"
 }