patternfly / patternfly/react-topology
Add documentation for adding a custom layout to an application
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 21
- Forks
- 27
- PR merge metrics
- No merged PRs in 30d
Description
Describe the problem
Applications may want to use a layout other than one of the provided layouts. This can be done but there is no clear documentation on what an application would need to do in order to use their own layout.
Expected behavior
There should be some documentation on what the custom layout should provide in order to be consumed and how to specify the new custom layout.
/cc @kialam
Jira Issue: PF-1998
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
No file or test is named. Start by reviewing the existing documentation and the API for the provided layouts, then document what a custom layout must provide and how an application selects it. Done means an application developer can follow the documentation to configure and consume a custom layout.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100