Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Docs generated in output-mode "group" are missing versions for multiversioned APIs

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

@sidharthsurana ci sta già lavorando.

Dal 22/8/2025.

  • #174 di @sidharthsurana — aperta

Valutazione

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

Direzione di ricerca

Inizia in renderer/renderer.go, intorno alle righe 86-96, e segui come la modalità di output "group" elabora i tipi API con più versioni. Verifica che la documentazione raggruppata generata conservi ogni versione dell’API invece di lasciare solo l’ultima versione dopo scritture ripetute dei file.

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

Descrizione

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

Lingua principale
Go
Stelle
176
Fork
81
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

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 elastic/crd-ref-docs

Tutte le issue di elastic/crd-ref-docs

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.