CRD doc generation leads to bad formatting

Aperta
#702 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
42/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
kubernetes
Ambito
documentation

Direzione di ricerca

Inizia con la sezione CRD di NiFi renderizzata all’URL crds.stackable.tech collegato e identifica come viene prodotta la documentazione di Quantity. Segui quell’input attraverso il flusso di generazione della documentazione, quindi verifica che i campi Quantity interessati vengano renderizzati senza la formattazione errata nella documentazione CRD generata.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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
Lingua principale
CSS
Stelle
13
Fork
14
Merge medio
4g 8h
PR unite (30g)
10

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di stackabletech/documentation

Tutte le issue di stackabletech/documentation

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.