stackabletech / stackabletech/documentation
CRD doc generation leads to bad formatting
未关闭
还没有人认领这个 Issue。
- 主要语言
- CSS
- 星标
- 13
- 派生
- 14
- 平均合并
- 4 天 8 小时
- 30 天内合并 PR
- 10
描述
E.g. In the NiFi CRD docs here https://crds.stackable.tech/24.11.0/nifi.stackable.tech/nificluster/v1alpha1/#spec-nodes-config-resources-storage-stateRepo-capacity (probably is everywhere where Quantity is used).
Possible fixes:
- We can try to remove that doc comment from rendering
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
调研方向
从链接的 crds.stackable.tech URL 中已渲染的 NiFi CRD 部分开始，确定 Quantity 文档是如何生成的。沿着文档生成流程跟踪该输入，然后验证受影响的 Quantity 字段在生成的 CRD 文档中渲染时没有错误的格式。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- kubernetes
- 领域
- documentation
- Issue 类型
- 缺陷
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 42/100