@patternfly/documentation-framework 6.0.0-alpha.81 → 6.0.0-alpha.83

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/README.md +5 -76
  3. package/package.json +3 -3
package/CHANGELOG.md CHANGED
@@ -3,6 +3,25 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # 6.0.0-alpha.83 (2024-08-20)
7
+
8
+
9
+ ### Bug Fixes
10
+
11
+ * **docs:** switched from v4 to evergreen badge link ([#4186](https://github.com/patternfly/patternfly-org/issues/4186)) ([9bbd121](https://github.com/patternfly/patternfly-org/commit/9bbd121302dc3f84231c6bf1de2680b47766b56c))
12
+
13
+
14
+
15
+
16
+
17
+ # 6.0.0-alpha.82 (2024-08-20)
18
+
19
+ **Note:** Version bump only for package @patternfly/documentation-framework
20
+
21
+
22
+
23
+
24
+
6
25
  # 6.0.0-alpha.81 (2024-08-20)
7
26
 
8
27
 
package/README.md CHANGED
@@ -16,53 +16,15 @@ We publish this theme [on npm.](https://www.npmjs.com/package/@patternfly/docume
16
16
 
17
17
  2. Provide or install the following either as dependencies if you want to use them in your own project, or as devDependencies:
18
18
  ```
19
- "@patternfly/patternfly": "^4.185.1",
20
- "@patternfly/react-core": "^4.202.16",
21
- "@patternfly/react-table": "^4.71.16",
22
- "@patternfly/react-code-editor": "^4.43.16",
19
+ "@patternfly/patternfly": "6.0.0-alpha.205",
20
+ "@patternfly/react-core": "6.0.0-alpha.94",
21
+ "@patternfly/react-table": "6.0.0-alpha.95",
22
+ "@patternfly/react-code-editor": "6.0.0-alpha.94",
23
23
  ```
24
24
  `yarn add -D @patternfly/patternfly @patternfly/react-core @patternfly/react-table @patternfly/react-code-editor`
25
25
 
26
- ### Resolutions
27
-
28
- 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:
29
- ```
30
- "resolutions": {
31
- "@types/react": "^16.8.0",
32
- "@types/react-dom": "^16.8.0",
33
- "react": "16.8.0",
34
- "react-dom": "16.8.0",
35
- "chromedriver": "102.0.0",
36
- "node-sass": "7.0.1",
37
- "puppeteer": "14.3.0",
38
- "sharp": "0.30.6"
39
- }
40
- ```
41
-
42
26
  ## First time setup
43
27
 
44
- ### Puppeteer
45
-
46
- Puppeteer is used to create screenshots, it requires chromium to be installed on your machine
47
-
48
- - install chromium using brew:
49
-
50
- `brew install chromium`
51
- - check the chromium path, should point to /opt/homebrew/bin/chromium:
52
-
53
- `which chromium`
54
- - export out the path:
55
-
56
- export PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true
57
-
58
- export PUPPETEER_EXECUTABLE_PATH=\`which chromium\`
59
-
60
- - So you don't have to retype this in the future, save to your shell rc file like .bashrc or .zshrc:
61
-
62
- echo 'export PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true' >> ~/.zshrc
63
-
64
- echo 'export PUPPETEER_EXECUTABLE_PATH=\`which chromium\`' >> ~/.zshrc
65
-
66
28
  ### Init documentation project
67
29
 
68
30
  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
81
43
 
82
44
  ### Develop docs
83
45
 
84
- `yarn docs:develop`
85
-
86
- or
87
-
88
46
  `npx pf-docs-framework start`
89
47
 
90
48
  ### Build docs
91
49
 
92
- `yarn docs:build`
93
-
94
- or
95
-
96
50
  `npx pf-docs-framework build all --output public`
97
51
 
98
52
  > 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.
99
53
 
100
- ### Generate screenshots
101
-
102
- You can generate screenshots against development or production builds.
103
-
104
- - Development:
105
-
106
- Terminal 1:
107
-
108
- `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)
109
-
110
- Terminal 2:
111
-
112
- `yarn docs:screenshots` or `npx pf-docs-framework screenshots --urlPrefix http://localhost:<PORT>`
113
-
114
- - Production:
115
-
116
- Terminal 1:
117
-
118
- - `yarn docs:build` or `npx pf-docs-framework build all --output public`
119
- - `yarn docs:serve` or `npx pf-docs-framework serve public --port 5000`
120
-
121
- Terminal 2:
122
-
123
- `yarn docs:screenshots` or `npx pf-docs-framework screenshots --urlPrefix http://localhost:5000`
124
-
125
- ### Publish docs to patternfly.org
54
+ ### Publish docs to patternfly.org
126
55
 
127
56
  1. Include the `patternfly-docs/content` and `patternfly-docs/generated` folders as part of your npm published module
128
57
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@patternfly/documentation-framework",
3
3
  "description": "A framework to build documentation for PatternFly.",
4
- "version": "6.0.0-alpha.81",
4
+ "version": "6.0.0-alpha.83",
5
5
  "author": "Red Hat",
6
6
  "license": "MIT",
7
7
  "private": false,
@@ -13,7 +13,7 @@
13
13
  "@babel/preset-env": "^7.24.3",
14
14
  "@babel/preset-react": "^7.24.1",
15
15
  "@mdx-js/util": "1.6.16",
16
- "@patternfly/ast-helpers": "^1.4.0-alpha.70",
16
+ "@patternfly/ast-helpers": "^1.4.0-alpha.72",
17
17
  "@reach/router": "npm:@gatsbyjs/reach-router@1.3.9",
18
18
  "autoprefixer": "9.8.6",
19
19
  "babel-loader": "^9.1.3",
@@ -80,5 +80,5 @@
80
80
  "react": "^17.0.0 || ^18.0.0",
81
81
  "react-dom": "^17.0.0 || ^18.0.0"
82
82
  },
83
- "gitHead": "4931930e766f2cf3049b5a91572406608d64917e"
83
+ "gitHead": "3fcc2d8bb313ecf45d69fe000256f482544fce65"
84
84
  }