patternfly / patternfly/patternfly-doc-core
Prop generation should pascal case all keys in props.json
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2
- Forks
- 11
- Avg merge
- 5d 15h
- Merged PRs (30d)
- 1
Description
Currently the keys in the props.json file generated by our prop data generation pipeline include suffixes such as -deprecated or -next
This leads to situations such as our deprecated components having names like Chip-deprecated, which doesn't otherwise match our route format and can make accessing deprecated/next components difficult.
We should pascal case the component/interface names to prevent this issue, and update any routes as needed to support this change.
Jira Issue: PF-3744
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 by locating the prop data generation pipeline that produces props.json and inspect how component and interface keys are formed. Check the related route handling as well. Done means suffixes such as -deprecated and -next are converted to PascalCase names and routes continue to access deprecated and next components correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100