Skip to content

Commit

Permalink
chore: Fixed wrong documentation, and removed redundnet build commands.
Browse files Browse the repository at this point in the history
  • Loading branch information
Donald Labaj committed Sep 9, 2024
1 parent e75efb5 commit 1b613a9
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 18 deletions.
2 changes: 1 addition & 1 deletion .github/workflows-src/partials/build.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
- uses: actions/setup-node@v1
with:
node-version: "16"
node-version: "20"
- uses: actions/cache@v2
id: yarn-cache
name: Load npm deps from cache
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pr-preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
key: ${{ runner.os }}-yarn-14-${{ hashFiles('yarn.lock') }}
- run: yarn install --frozen-lockfile
if: steps.yarn-cache.outputs.cache-hit != 'true'
# v5 build
# build
- uses: actions/cache@v2
id: site-cache
name: Load webpack cache
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ A local development server at http://localhost:8003 can be started with:

### Build

The new v6 site can be built with:
The site can be built with:

yarn build:v6
yarn build

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

Expand All @@ -34,7 +34,7 @@ If you see errors, make sure that the version of the `package.json` file in `pac

When you submit a PR, previews should be automatically generated for you and uploaded as PR comments. This takes between 5-10 minutes.

When the PR is merged to main, the site is first deployed to a [staging S3 bucket.](https://staging.patternfly.org)
When the PR is merged to main, the site is first deployed to a [staging S3 bucket.](https://staging-v6.patternfly.org)

When PatternFly does a release (currently every 3 weeks) this bucket is copied to https://patternfly.org.

Expand Down
20 changes: 8 additions & 12 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,17 @@
"license": "MIT",
"scripts": {
"analyze": "yarn workspace patternfly-org analyze",
"develop": "yarn develop:v6",
"develop:v6": "yarn workspace patternfly-org develop",
"develop:extensions": "EXTENSIONS_ONLY=true PRERELEASE=true yarn develop:v6",
"build": "yarn build:v6",
"build:analyze": "yarn workspace patternfly-org build:analyze && yarn copy:v6",
"build:v4": "yarn build:v6",
"build:v6": "yarn workspace patternfly-org build && yarn copy:v6",
"build:extensions": "EXTENSIONS_ONLY=true PRERELEASE=true yarn build:v6",
"copy:v6": "rm -rf build/patternfly-org/site && mkdir -p build/patternfly-org && cp -r packages/documentation-site/public build/patternfly-org/site",
"develop": "yarn workspace patternfly-org develop",
"develop:extensions": "EXTENSIONS_ONLY=true PRERELEASE=true yarn develop",
"build:analyze": "yarn workspace patternfly-org build:analyze && yarn copy",
"build": "yarn workspace patternfly-org build && yarn copy",
"build:extensions": "EXTENSIONS_ONLY=true PRERELEASE=true yarn build",
"copy": "rm -rf build/patternfly-org/site && mkdir -p build/patternfly-org && cp -r packages/documentation-site/public build/patternfly-org/site",
"clean": "lerna run clean && rm -rf build",
"serve": "npx pf-docs-framework serve build/patternfly-org/site",
"test:v6": "yarn workspace patternfly-org test:a11y:ci",
"test": "yarn workspace patternfly-org test:a11y:ci",
"screenshots": "node node_modules/puppeteer/install.js && yarn workspace patternfly-org screenshots",
"start": "yarn start:v6",
"start:v6": "yarn develop:v6",
"start": "yarn develop",
"start:extensions": "yarn develop:extensions",
"uninstall": "find . -name node_modules | xargs rm -rf",
"workflows": "node .github/generate-workflows",
Expand Down
2 changes: 1 addition & 1 deletion packages/documentation-site/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"screenshots": "pf-docs-framework screenshots"
},
"dependencies": {
"@patternfly/documentation-framework": "6.0.0-alpha.89",
"@patternfly/documentation-framework": "6.0.0-alpha.90",
"@patternfly/react-catalog-view-extension": "6.0.0-alpha.7",
"@patternfly/react-console": "6.0.0-alpha.5",
"@patternfly/react-docs": "7.0.0-alpha.113",
Expand Down

0 comments on commit 1b613a9

Please sign in to comment.