patternfly / patternfly/patternfly-org
Instructions for importing utility styles
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 74
- Forks
- 147
- Avg merge
- 4d 11h
- Merged PRs (30d)
- 2
Description
"About utility classes" and each utility class page should include a blurb or alert about the need to specifically import the utilities stylesheet (and instructions or a link to instructions for this) in order to enable these classes. This question comes up often but does not look to be explained currently anywhere as an extra required step.
Jira Issue: PF-322
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with packages/documentation-site/patternfly-docs/pages/landing-pages/utility-classes/utility-classes.md and the utility class page handling in packages/documentation-framework/templates/mdx.js. Check how the landing page and individual utility pages are assembled, then add the required utilities stylesheet import guidance or a link to it in both places. Done means users can find this instruction on the overview and each utility class page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- css, javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100