open-feature/open-feature-operator

get rid of redundant crd documentation

Offen

#475 geöffnet am 17.04.2023

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Go (58 Forks)github user discovery
contribfestdocumentationgood first issuehelp wanted

Repository-Metriken

Stars
 (300 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 1h 2m) (1 gemergte PR in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Untersuche das crdoc Kommando und sein Templatesystem, um eine benutzerdefinierte .tmpl Datei zu erstellen, die Kern Kubernetes Felder wie env valueFrom Referenzen ausschließt.
Tech Stack
gokubernetes
Domain
backendinfrastructuredocumentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GoKubernetes
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60