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

Generate unique type headers

Aperta
#30 1 commento 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

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

Direzione di ricerca

Inizia leggendo il modello markdown e la funzione RenderTypeLink menzionati nell’issue, quindi segui come vengono generati le intestazioni e i link dei tipi. Il lavoro è completo quando le intestazioni includono la versione, così che i tipi ripetuti abbiano anchor univoci, e i link provenienti da altri file markdown vengano risolti nella versione prevista.

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

Descrizione

enhancement

The current headers in the markdown template are not guaranteed to be unique since they do not include the version. For my use case I have multiple versions of a CRD with the same types in each version. Since the output is all in one file, when I want to link to a type from another markdown file (like out.md#typename), it will only ever link to the first heading matching the link, which could be an out of date reference. I tried creating my own template for this but the issue is the markdown RenderTypeLink function will no longer create accurate links with the change.

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.