CRD doc generation leads to bad formatting

オープン
#702 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
42/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
kubernetes
領域
documentation

調査の方向性

リンクされた crds.stackable.tech URL にあるレンダリング済みの NiFi CRD セクションから始め、Quantity のドキュメントがどのように生成されるかを特定します。その入力をドキュメント生成フローを通して追跡し、影響を受ける Quantity フィールドが生成された CRD ドキュメント全体で不正なフォーマットなしにレンダリングされることを確認します。

索引モデルが issue の本文から書いたものです。

説明

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).

Image

Possible fixes:

  • We can try to remove that doc comment from rendering
主要言語
CSS
スター
13
フォーク
14
平均マージ
4日 8時間
マージ済み PR(30日)
10

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

stackabletech/documentation のほかの issue

stackabletech/documentation の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。