Skip to content

Commit b307a36

Browse files
committed
PR feedback
Signed-off-by: Jon Koops <jonkoops@gmail.com>
1 parent b827a79 commit b307a36

File tree

11 files changed

+77
-60
lines changed

11 files changed

+77
-60
lines changed

.github/release.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ LOG=$(git log --format="%s" -1 | grep -Poe "#\d+")
1818
PR_NUM=${LOG:1}
1919

2020
# for running a dry run
21-
#pnpm run lerna version --conventional-commits --no-private --yes --no-git-tag-version --no-push
21+
# pnpm exec lerna version --conventional-commits --no-private --yes --no-git-tag-version --no-push
2222

2323
# for publishing
24-
pnpm run lerna publish --conventional-commits --create-release=github --no-verify-access --no-private --yes 2>&1 | tee lerna-output.txt
24+
pnpm exec lerna publish --conventional-commits --create-release=github --no-verify-access --no-private --yes 2>&1 | tee lerna-output.txt
2525

2626
if grep -i "Successfully published" lerna-output.txt; # Leave a Github comment
2727
then

.github/workflows-src/partials/build.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
with:
33
node-version: 22
44
- run: corepack enable
5-
- run:pnpm install --immutable
5+
- run: pnpm install
66
# v5 build
77
- uses: actions/cache@v4
88
id: site-cache
99
name: Load webpack cache
1010
with:
1111
path: "packages/documentation-site/.cache"
12-
key: ${{ runner.os }}-${{ hashFiles('yarn.lock') }}
13-
- run:pnpm build
12+
key: ${{ runner.os }}-${{ hashFiles('pnpm-lock.yaml') }}
13+
- run: pnpm build
1414
name: Build docs

.github/workflows/pr-preview.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ jobs:
2020
with:
2121
node-version: 22
2222
- run: corepack enable
23-
- run:pnpm install --immutable
23+
- run: pnpm install
2424
# build
2525
- uses: actions/cache@v4
2626
id: site-cache
2727
name: Load webpack cache
2828
with:
2929
path: "packages/documentation-site/.cache"
30-
key: ${{ runner.os }}-${{ hashFiles('yarn.lock') }}
31-
- run:pnpm build
30+
key: ${{ runner.os }}-${{ hashFiles('pnpm-lock.yaml') }}
31+
- run: pnpm build
3232
name: Build docs
3333
- run: node .github/upload-preview.js build/patternfly-org/site site
3434
name: Upload docs

.github/workflows/release.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ jobs:
2323
with:
2424
node-version: 22
2525
- run: corepack enable
26-
- run:pnpm install --immutable
26+
- run: pnpm install
2727
# v6 build
2828
- uses: actions/cache@v4
2929
id: site-cache
3030
name: Load webpack cache
3131
with:
3232
path: "packages/documentation-site/.cache"
33-
key: ${{ runner.os }}-site-${{ hashFiles('yarn.lock') }}
34-
- run:pnpm build
33+
key: ${{ runner.os }}-site-${{ hashFiles('pnpm-lock.yaml') }}
34+
- run: pnpm build
3535
name: Build docs
3636
- run: .github/release.sh
3737
- name: Configure AWS Credentials
@@ -46,7 +46,7 @@ jobs:
4646
name: Check size of docs
4747
- run: .github/upload-staging.sh
4848
name: Upload docs to staging
49-
- run:pnpm build:extensions
49+
- run: pnpm build:extensions
5050
name: Build extension docs
5151
- name: Upload extension only docs
5252
uses: dswistowski/surge-sh-action@v1

.gitignore

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,3 @@ static
3333

3434
size-plugin.json
3535
**/generated/**/*.js
36-
37-
# Yarn
38-
# See: https://yarnpkg.com/getting-started/qa#which-files-should-be-gitignored
39-
.pnp.*
40-
.yarn/*
41-
!.yarn/patches
42-
!.yarn/plugins
43-
!.yarn/releases
44-
!.yarn/sdks
45-
!.yarn/versions

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The PatternFly Org is the source for the official documentation for PatternFly.
44

55
## Development
66

7-
Development setup requirespnpm. If you do not already havepnpm installed on your system, see https://yarnpkg.com/getting-started.
7+
Development setup requires PNPM. If you do not already have PNPM installed on your system, see https://pnpm.io/installation#using-corepack
88

99
A Node version 22 or greater is also required.
1010

@@ -14,17 +14,23 @@ A Node version 22 or greater is also required.
1414

1515
You can install the NPM dependencies with:
1616

17-
pnpm install
17+
```sh
18+
pnpm install
19+
```
1820

1921
A local development server at http://localhost:8003 can be started with:
2022

21-
pnpm start
23+
```sh
24+
pnpm start
25+
```
2226

2327
### Build
2428

2529
The site can be built with:
2630

27-
pnpm build
31+
```sh
32+
pnpm build
33+
```
2834

2935
The static assets get copied to build/patternfly-org.
3036

@@ -39,7 +45,7 @@ When PatternFly does a release (currently every 3 weeks) this bucket is copied t
3945
### Update screenshots
4046
To update the screenshots (these are the images that you click on to see a full-page demo):
4147

42-
- open a terminal and run `pnpm build &&pnpm serve`
48+
- open a terminal and run `pnpm build && pnpm serve`
4349
- in another terminal, run `pnpm screenshots`
4450

4551
Make sure that the version of Chromium you are using is relatively recent. Version 112.0.5614.0 (Developer Build), for example, isn't compatible with the latest versions of PatternFly, and your screenshots will be off.
@@ -50,7 +56,9 @@ Browse the screenshots to make sure that nothing seems super off. You can compar
5056

5157
You might have a dirty file tree with old submodules and folders lying around. You can remove these with:
5258

53-
git clean -dfx
59+
```sh
60+
git clean -dfx
61+
```
5462

5563
### Contribute to HTML/CSS
5664

lerna.json

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"npmClient": "yarn",
2+
"npmClient": "pnpm",
33
"publishConfig": {
44
"access": "public",
55
"registry": "https://registry.npmjs.org/"
@@ -10,11 +10,6 @@
1010
"conventionalCommits": true
1111
}
1212
},
13-
"packages": [
14-
"packages/ast-helpers",
15-
"packages/documentation-framework",
16-
"packages/documentation-site"
17-
],
1813
"version": "independent",
1914
"allowBranch": ["main", "v4", "v5"]
2015
}

package.json

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
{
2-
"name": "patternfly-org---filter",
2+
"name": "patternfly-org-workspace",
33
"private": true,
44
"version": "0.0.1",
55
"main": "index.js",
66
"license": "MIT",
7+
"packageManager": "pnpm@10.6.4+sha512.da3d715bfd22a9a105e6e8088cfc7826699332ded60c423b14ec613a185f1602206702ff0fe4c438cb15c979081ce4cb02568e364b15174503a63c7a8e2a5f6c",
78
"scripts": {
89
"analyze": "pnpm --filter patternfly-org analyze",
910
"develop": "pnpm --filter patternfly-org develop",
10-
"develop:extensions": "EXTENSIONS_ONLY=true PRERELEASE=truepnpm develop",
11-
"build:analyze": "pnpm --filter patternfly-org build:analyze &&pnpm copy",
12-
"build": "pnpm --filter patternfly-org build &&pnpm copy",
13-
"build:extensions": "EXTENSIONS_ONLY=true PRERELEASE=truepnpm build",
11+
"develop:extensions": "EXTENSIONS_ONLY=true PRERELEASE=true pnpm develop",
12+
"build:analyze": "pnpm --filter patternfly-org build:analyze && pnpm copy",
13+
"build": "pnpm --filter patternfly-org build && pnpm copy",
14+
"build:extensions": "EXTENSIONS_ONLY=true PRERELEASE=true pnpm build",
1415
"copy": "rm -rf build/patternfly-org/site && mkdir -p build/patternfly-org && cp -r packages/documentation-site/public build/patternfly-org/site",
1516
"clean": "lerna run clean && rm -rf build",
1617
"serve": "npx pf-docs-framework serve build/patternfly-org/site",
@@ -22,11 +23,6 @@
2223
"workflows": "node .github/generate-workflows",
2324
"test:a11y": "pnpm --filter patternfly-org test:a11y"
2425
},
25-
"--filters": {
26-
"packages": [
27-
"packages/*"
28-
]
29-
},
3026
"devDependencies": {
3127
"@octokit/rest": "^19.0.7",
3228
"@patternfly/patternfly": "^6.1.0",
@@ -41,6 +37,5 @@
4137
},
4238
"resolutions": {
4339
"node-sass": ">=6.0.1"
44-
},
45-
"packageManager": "pnpm@10.6.4+sha512.da3d715bfd22a9a105e6e8088cfc7826699332ded60c423b14ec613a185f1602206702ff0fe4c438cb15c979081ce4cb02568e364b15174503a63c7a8e2a5f6c"
40+
}
4641
}

packages/documentation-framework/README.md

Lines changed: 34 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,48 +8,71 @@ We publish this theme [on npm.](https://www.npmjs.com/package/@patternfly/docume
88

99
1. @patternfly/documentation-framework
1010

11-
`npm i --save-dev @patternfly/documentation-framework`
11+
```sh
12+
npm i --save-dev @patternfly/documentation-framework
13+
```
1214

1315
or
1416

15-
`pnpm add -D @patternfly/documentation-framework`
17+
```sh
18+
pnpm add --save-dev @patternfly/documentation-framework
19+
```
1620

1721
2. Provide or install the following either as dependencies if you want to use them in your own project, or as devDependencies:
18-
```
22+
```json
1923
"@patternfly/patternfly": "6.0.0-alpha.205",
2024
"@patternfly/react-core": "6.0.0-alpha.94",
2125
"@patternfly/react-table": "6.0.0-alpha.95",
2226
"@patternfly/react-code-editor": "6.0.0-alpha.94",
2327
```
24-
`pnpm add -D @patternfly/patternfly @patternfly/react-core @patternfly/react-table @patternfly/react-code-editor`
28+
```sh
29+
pnpm add --save-dev @patternfly/patternfly @patternfly/react-core @patternfly/react-table @patternfly/react-code-editor
30+
```
2531

2632
## First time setup
2733

2834
### Init documentation project
2935

3036
To get started, you can scaffold out a sample extension docs setup:
3137

32-
`npx pf-docs-framework init --name "My extension"`
38+
```sh
39+
npx pf-docs-framework init --name "My extension"
40+
```
3341

3442
If you also want to add relevant script targets to package.json, pass in `--scripts` as well:
3543

36-
`npx pf-docs-framework init --name "My extension" --scripts`
44+
```sh
45+
npx pf-docs-framework init --name "My extension" --scripts
46+
```
3747

3848
## Usage
3949

40-
For all CLI options, run `npx pf-docs-framework --help`
50+
For all CLI options, run:
51+
52+
```sh
53+
npx pf-docs-framework --help
54+
```
55+
56+
For individual CLI commands, you can also display more information by running:
4157

42-
For individual CLI commands, you can also display more information by running `npx pf-docs-framework <COMMAND> --help`
58+
```sh
59+
npx pf-docs-framework <COMMAND> --help
60+
```
4361

4462
### Develop docs
4563

46-
`npx pf-docs-framework start`
64+
```sh
65+
npx pf-docs-framework start
66+
```
4767

4868
### Build docs
4969

50-
`npx pf-docs-framework build all --output public`
70+
```sh
71+
npx pf-docs-framework build all --output public
72+
```
5173

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.
74+
> [!NOTE]
75+
> 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.
5376

5477
### Publish docs to patternfly.org
5578

packages/documentation-site/patternfly-docs/content/get-started/develop.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ In order to develop with PatternFly, you will need to:
1313

1414
1. [Learn about our design token system](/tokens/about-tokens), which enables you to build interfaces with consistent PatternFly styling, including colors, shadows, spacing, and more.
1515

16-
1. Install a package manager to help you install, update, and configure all necessary PatternFly packages. We recommend [npm](https://nodejs.org/en/download) or [Yarn](https://yarnpkg.com/getting-started).
16+
1. Install a package manager to help you install, update, and configure all necessary PatternFly packages. We recommend [npm](https://nodejs.org/en/download) or [PNPM](https://pnpm.io/installation).
1717

1818
1. Configure your environment to get started with our [React](#develop-with-react) and/or [HTML/CSS](#develop-with-htmlcss) libraries.
1919

0 commit comments

Comments
 (0)