patternfly / patternfly/patternfly-react

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

Đang mở
#7,010 4 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Content Documentation :memo: Pinned
Ngôn ngữ chính
TypeScript
Star
862
Fork
392
Merge trung bình
4 ngày 8 giờ
Pull request đã merge (30 ngày)
9

Mô tả

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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu với các trang tài liệu về component được liệt kê trong issue và xem xét các ví dụ, các phần Props hiện có cũng như các ví dụ đang hoạt động trong #7603. Thống nhất về những sub-component nào thuộc Props và những trang nào cần một phần tổng quát về cấu trúc dự kiến, sau đó cập nhật các trang component chưa được đánh dấu và xác minh rằng các ví dụ và mô tả được ghi chép nhất quán.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
react, typescript
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
30/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.