elastic / elastic/crd-ref-docs
Docs generated in output-mode "group" are missing versions for multiversioned APIs
- 主要言語
- Go
- スター
- 173
- フォーク
- 81
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
For a multi versioned API type, when generating a output-mode "group" rendering, the generated one only contains 1 version of the api.
This is primarily becasue we are overwiting the same named file for all the versions one at a time, thus the last one is what is left generated
primarily due to the following code block we iterate over all the gvd without first grouping them based on the group. https://github.com/elastic/crd-ref-docs/blob/7de989285647936ac62ea1ff8887e25e0056bc58/renderer/renderer.go#L86-L96
コントリビューションガイド
調査の方向性
renderer/renderer.go の 86〜96 行付近から始め、出力モード "group" が複数バージョンの API 型をどのように処理するかを追跡します。生成されたグループ化ドキュメントが、ファイルへの書き込みを繰り返した後も最後のバージョンだけを残すのではなく、すべての API バージョンを保持していることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- go, kubernetes
- 領域
- documentation
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100