CRD doc generation leads to bad formatting

Offen
#702 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
42/100
Issue-Typ
Bug
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
kubernetes
Bereich
documentation

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.

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

Image

Possible fixes:

  • We can try to remove that doc comment from rendering
Vorherrschende Sprache
CSS
Sterne
13
Forks
14
Ø Merge
4 T. 8 Std.
Gemergte PRs (30 T.)
10

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus stackabletech/documentation

Alle Issues in stackabletech/documentation

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.