stackabletech / stackabletech/documentation
CRD doc generation leads to bad formatting
オープン
まだ誰も着手していません。
- 主要言語
- CSS
- スター
- 13
- フォーク
- 14
- 平均マージ
- 4日 8時間
- マージ済み PR（30日）
- 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 にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
リンクされた crds.stackable.tech URL にあるレンダリング済みの NiFi CRD セクションから始め、Quantity のドキュメントがどのように生成されるかを特定します。その入力をドキュメント生成フローを通して追跡し、影響を受ける Quantity フィールドが生成された CRD ドキュメント全体で不正なフォーマットなしにレンダリングされることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- kubernetes
- 領域
- documentation
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 42/100