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

[Feature Request]: Incorrect links to multi-version CRDs

Aperta
#60 7 commenti 2 reazioni 0 assegnatari Vedi su GitHub

@antonincms ci sta già lavorando.

Dal 27/11/2024.

  • #118 di @antonincms — aperta

Valutazione

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

Direzione di ricerca

Nell’issue #60 non sono indicati né un file sorgente né un test. Inizia individuando la logica del generatore che crea ancore e link Markdown per i tipi di risorsa CRD versionati, quindi confronta il comportamento previsto con l’esempio collegato di Kubernetes Docs. Il lavoro è completato quando i link di v2 Foo e FooList portano alle rispettive intestazioni v2 anziché alle intestazioni v1.

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

Descrizione

I used crd-ref-docs to generate API documentation for a multi-version CRD.

# API Reference

## Packages
- [example.dev/v1](#exampledevv1)
- [example.dev/v2](#exampledevv2)


## example.dev/v1

### Resource Types
- [Foo](#foo)
- [FooList](#foolist)

#### Foo                        
                                <- Jump to here

## example.dev/v2

### Resource Types
- [Foo](#foo)                   <-  Click this 
- [FooList](#foolist)

#### Foo
                                <- Expect to jump to here

Clicking on the v2 version of Foo redirects to the v1 version of Foo

Refer to the implementation of Kubernetes Docs

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.