open-feature/open-feature-operator

get rid of redundant crd documentation

Aperta

#475 aperta il 17 apr 2023

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)Go (58 fork)github user discovery
contribfestdocumentationgood first issuehelp wanted

Metriche repository

Star
 (300 stelle)
Metriche merge PR
 (Merge medio 1h 2m) (1 PR mergiata in 30 g)

Descrizione

We could make a custom .tmpl to pass crdoc command to avoid generating redundant tables with k8s core infos such as:

FeatureFlagConfiguration.spec.flagDSpec.envs[index].valueFrom
FeatureFlagConfiguration.spec.flagDSpec.envs[index].valueFrom.configMapKeyRef
FeatureFlagConfiguration.spec.flagDSpec.envs[index].valueFrom.fieldRef
FeatureFlagConfiguration.spec.flagDSpec.envs[index].valueFrom.resourceFieldRef
FeatureFlagConfiguration.spec.flagDSpec.envs[index].valueFrom.secretKeyRef

Guida contributor

Direzione di ricerca
Esamina il comando crdoc e il suo sistema di template per creare un file .tmpl personalizzato che escluda i campi principali di Kubernetes come i riferimenti a valueFrom di env.
Tech stack
gokubernetes
Dominio
backendinfrastructuredocumentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GoKubernetes
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60