Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Add guidelines on how to use components together

未关闭
#86 1 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
技术栈
react, typescript
领域
documentation

调研方向

首先查看 repository README 和 patternfly.org 上现有的内容,以确定当前对 extension 及其 components 的说明。完成的标准是两个界面都能说明 extension 的用途,展示 components 如何协同工作,并提供所要求的更广泛概述。

由索引模型根据 Issue 内容生成。

描述

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

主要语言
TypeScript
星标
3
派生
14
PR 合并指标
30 天内没有已合并 PR

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

patternfly/react-catalog-view 的其他 Issue

查看 patternfly/react-catalog-view 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。