patternfly / patternfly/react-catalog-view

Add guidelines on how to use components together

Open
#86 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

PF Team
Dominant language
TypeScript
Stars
3
Forks
14
PR merge metrics
No merged PRs in 30d

Description

The repo README does not clearly state the purpose of the extension or how the components can be used together. Similarly, we lack any sort of overview on the main PF website that shows how these components can be put together.

We should update/add these and make it clearer how these components can be used together and what they are for.

From Andrew Ballantyne:

I’m not sure what I am supposed to be able to glean from the docs on patternfly.org. The Repo README seems a bit lacking too… If I wanted to use this, how do I see what it is offering? Do we have a rendering/sandbox mode of it somewhere?

I guess I was looking for the “how it all works together” experience, and I can’t find one that shows me that. We were having a UX meeting and I was curious what the experience was like to have a catalog, and felt like this set of data very weirdly structured. I guess if I was familiar with the extension, these individual components would be helpful as any component documentation in PF docs are — looking at use-cases and props and what have you — but it seemed to be missing the “bigger picture” stuff. I guess an overview page/README would solve that in some degree


Jira Issue: PF-2492

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 reviewing the repository README and the existing content on patternfly.org to identify the current explanation of the extension and its components. Done means both surfaces explain the extension’s purpose, show how components work together, and provide the requested broader overview.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.