Support for multiple source paths
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 45/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- go, kubernetes
- Ambito
- documentation, tooling
Direzione di ricerca
Inizia da processor/processor.go, dove vengono analizzati i percorsi sorgente, e leggi l’API LoadRoots di controller-tools citata nell’issue. Il lavoro è completato quando il generatore accetta più percorsi sorgente, in modo che ogni CRD possa essere documentata insieme alla propria directory comune, senza dipendere dalle esclusioni di config.yaml.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
When generating docs for the operator with mutliple CRDs in different paths, it would be nice to specify multiple source paths. For ex, in the following folder structure -
api
- crd1
- crd2
- common
common contains shared structs used by both crd1 and crd2 CRDs. To generate adocs for crd1, I would have to pass folders crd1 and common. Similarly crd2 and common folders if I want docs for crd2.
I looked at the code that parses the source paths (processor/processor.go) and found out that the controller-tools has a LoadRoots api that supports reading from multiple source paths. So it shouldnt be too complex to support multiple source paths.
As a workaround to this problem, we are using config.yaml to exclude types in each adoc.
- Lingua principale
- Go
- Stelle
- 176
- Fork
- 81
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di elastic/crd-ref-docs
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
elastic/crd-ref-docs#204 ·
-
Support for +kubebuilder:validation:Required and omitemptyForse già presa @swathinsankaran l’ha presa 117 giorni fa. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
elastic/crd-ref-docs#198 · 1 reazione ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
elastic/crd-ref-docs#191 ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
elastic/crd-ref-docs#188 · 2 commenti ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
elastic/crd-ref-docs#182 ·
Tutte le issue di elastic/crd-ref-docs
Issue simili
-
clawsweeper:fix-shape-clear clawsweeper:queueable-fix clawsweeper:source-repro impact:session-state issue-rating: 🦞 diamond lobster no-stale P2
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
openclaw/wacli#503 · 1 commento · 1 reazione ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 81/100
apache/rocketmq-dashboard#6895 ·
I maintainer di solito rispondono entro 3 giorni
-
agent-butler-finding chore
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
jordansmall/spindrift#5466 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 92/100
open-telemetry/opentelemetry-go-compile-instrumentation#1507 ·
I maintainer di solito rispondono entro 3 giorni
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 87/100
777genius/agent-notifications#490 ·
I maintainer di solito rispondono entro 1 giorno