open-feature/open-feature-operator

get rid of redundant crd documentation

Ouverte

#475 ouverte le 17 avr. 2023

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)Go (58 forks)github user discovery
contribfestdocumentationgood first issuehelp wanted

Métriques du dépôt

Stars
 (300 étoiles)
Métriques de merge PR
 (Merge moyen 1h 2m) (1 PR mergée en 30 j)

Description

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

Guide contributeur

Direction de recherche
Examinez la commande crdoc et son système de templates pour créer un fichier .tmpl personnalisé qui exclut les champs principaux de Kubernetes tels que les références valueFrom de env.
Stack technique
gokubernetes
Domaine
backendinfrastructuredocumentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GoKubernetes
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60