Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Add guidelines on how to use components together

Aperta
#86 1 commento 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
react, typescript
Ambito
documentation

Direzione di ricerca

Inizia esaminando il README del repository e i contenuti esistenti su patternfly.org per identificare la spiegazione attuale dell’estensione e dei suoi componenti. Il lavoro è completato quando entrambe le superfici spiegano lo scopo dell’estensione, mostrano come i componenti lavorano insieme e forniscono la panoramica più ampia richiesta.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

PF Team

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

Lingua principale
TypeScript
Stelle
3
Fork
14
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di patternfly/react-catalog-view

Tutte le issue di patternfly/react-catalog-view

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.