patternfly / patternfly/patternfly-org

Create a new repo for "integration" demos which consume our extensions

Open
#4,852 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

PF Team
Dominant language
JavaScript
Stars
74
Forks
147
Avg merge
4d 11h
Merged PRs (30d)
2

Description

Currently any demos which need to import components from our extensions need to either live in the extension themselves (where they likely wouldn't make sense if they aren't actually part of the extension) or live in this repo under the documentation-site package.

Placing demos directly in org has exposed several significant issues due to the nature of how the docs framework operates, and also isn't the cleanest approach because it it requires introducing typescript compilation and other new dependencies into org.

To resolve these issues we should create a new repo for extension consuming demos to live in, and extract the compass demos and the animation demo into that repo.


Jira Issue: PF-2924

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the compass demos and animation demo under the documentation-site package and reviewing how they currently consume extension components. Done means a new repository exists for integration demos and those demos are extracted from this repository without requiring the added dependencies in the org package.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
build-system, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.