patternfly-org

The PatternFly Org is the source for the official documentation for PatternFly.

Development

Development setup requires yarn. If you do not already have yarn installed on your system, see https://yarnpkg.com/en/.

A Node version greater than 18.16.0 is also required.

You can install the NPM dependencies with:

yarn install

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

yarn start

The new v5 site can be built with:

yarn build:v5

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

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.

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

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

git clean -dfx

To contribute to PatternFly's HTML/CSS core repo, refer to the core contribution guide and the related guidelines.