patternfly / patternfly/patternfly-react

Chore(docs): Add composable structure section and component descriptions to documentation

Aperta
#7,010 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Content Documentation :memo: Pinned
Lingua principale
TypeScript
Stelle
862
Fork
392
Merge medio
4g 8h
PR unite (30g)
9

Descrizione

Describe the issue. What is the expected and unexpected behavior?
Consider adding a "General intended structure" section to documentation for more compassable components, and add descriptions for sub-components in the "Props" section to provide more details on their use-cases.

For sub-component descriptions, we should consider ensuring that any sub-components used in examples/exported for consumer use are added to the "Props" section. For example, Application Launcher has examples using ApplicationLauncherSeparator, but that is not included in the props section of the component page. Note: this will cause an issue for sub-components that do not export a props interface, as an empty table will be rendered to that section of the component page.

Additionally, we should align on when to include other components on a page's "Props" section. The Login Page component, for example, uses List and ListItem in some examples, but does not include the props table for them. The Alert Group component on the other hand includes the Alert props table.

e.g.
General intended structure
File upload - multiple is designed in a composable manner to maximize flexibility. The general intended component relationships are arranged similarly to:

See #7603 for working examples

Is this a bug or enhancement? If this issue is a bug, is this issue blocking you or is there a work-around?
enhancement

Needs only sub-component descriptions:

  • #7973

  • #7978

  • #8105

  • Wizard

Needs both "composable structure" and sub-component descriptions:

  • Accordion

  • Action list

  • Alert group (currently the alert group page includes Alert specific components in the "Props" section)

  • Application launcher (partially composable)

  • Breadcrumb

  • Card

  • Clipboard copy (currently the component page includes ClipboardCopyButton in the "Props" section, but the component isn't used in any examples. If we want to keep this, it may be worth considering whether any other sub-components should be exposed on all components)

  • Chip group (currently the chip group page includes the Chip component in the "Props" section)

  • Code block

  • Context selector

  • Data list

  • Description list

  • Drag and drop (wait for Nicole to provide feedback)

  • Drawer

  • Dropdown (partially composable)

  • #7692

  • Empty state

  • Form

  • Form select

  • Helper text

  • Hint

  • Input group

  • Jump links

  • Label group (currently the label group page includes the Label component in its "Props" section)

  • List

  • Login page

  • Masthead

  • Menu

  • #7691

  • Navigation

  • Notification drawer

  • Options menu (partially composable)

  • Overflow menu

  • Page

  • Panel

  • Progress stepper

  • Select (partially composable)

  • Sidebar

  • Simple list

  • Table Composable (because of the different variants of a table, the structure section may need to be split up to several different ones)

  • Table Legacy (could arguably only require sub-component descriptions, but since examples show the TableHeader inside of Table it might be good to include some sort of "intended structure" section/mention)

  • Tabs

  • Text

  • Text input group

  • Toggle group

  • Toolbar


Jira Issue: PF-187

Guida per i contributori

Apri la guida per i contributori

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.

Direzione di ricerca

Inizia dalle pagine della documentazione dei componenti elencate nell’issue e verifica gli esempi, le sezioni Props esistenti e gli esempi funzionanti in #7603. Concorda su quali sottocomponenti debbano appartenere a Props e quali pagine necessitino di una sezione generale sulla struttura prevista, quindi aggiorna le pagine dei componenti non selezionate e verifica che esempi e descrizioni siano documentati in modo coerente.

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

Valutazione

Stack tecnologico
react, typescript
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
30/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.