Add guidelines on how to use components together
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức phù hợp với người mới
- 35/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- react, typescript
- Lĩnh vực
- documentation
Hướng nghiên cứu
Bắt đầu bằng cách xem xét README của repository và nội dung hiện có trên patternfly.org để xác định phần giải thích hiện tại về extension và các component của nó. Công việc được xem là hoàn tất khi cả hai bề mặt đều giải thích mục đích của extension, cho thấy các component hoạt động cùng nhau như thế nào và cung cấp phần tổng quan rộng hơn được yêu cầu.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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
- Ngôn ngữ chính
- TypeScript
- Star
- 3
- Fork
- 14
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của patternfly/react-catalog-view
-
PF Team
patternfly/react-catalog-view#94 · 1 người được giao ·
-
PF Team
patternfly/react-catalog-view#88 · 2 bình luận · 1 người được giao ·
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 45/100
-
PF Team
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 20/100
-
PF Team
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 45/100
Tất cả issue của patternfly/react-catalog-view
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
bcgov/bc-wallet-mobile#4761 · 1 bình luận ·
-
external-issue to-triage
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
-
area-deployment area-integrations triage:bot-seen
Độ khó 2/5 Nửa ngày Mức phù hợp với người mới 86/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
-
refactor
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100