stackabletech / stackabletech/documentation
CRD doc generation leads to bad formatting
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- CSS
- Sterne
- 13
- Forks
- 14
- Ø Merge
- 4 T. 8 Std.
- Gemergte PRs (30 T.)
- 10
Beschreibung
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
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginnen Sie mit dem gerenderten NiFi-CRD-Abschnitt unter der verlinkten crds.stackable.tech-URL und ermitteln Sie, wie die Quantity-Dokumentation erzeugt wird. Verfolgen Sie diese Eingabe durch den Dokumentationsgenerierungsablauf und überprüfen Sie anschließend, dass die betroffenen Quantity-Felder in der generierten CRD-Dokumentation ohne die fehlerhafte Formatierung gerendert werden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- kubernetes
- Bereich
- documentation
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 42/100