patternfly / patternfly/patternfly-react

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

Ouverte
#7,010 4 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Content Documentation :memo: Pinned
Langage dominant
TypeScript
Étoiles
862
Forks
392
Merge moyen
4 j 8 h
PR mergées (30 j)
9

Description

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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par les pages de documentation des composants listées dans l’issue et examinez les exemples, les sections Props existantes et les exemples fonctionnels de #7603. Déterminez quels sous-composants doivent figurer dans Props et quelles pages ont besoin d’une section générale sur la structure prévue, puis mettez à jour les pages de composants non cochées et vérifiez que les exemples et les descriptions sont documentés de manière cohérente.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
react, typescript
Domaine
documentation
Type d'issue
Documentation
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
30/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.