open-feature/open-feature-operator

get rid of redundant crd documentation

Open

#475 opened on Apr 17, 2023

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Go (58 forks)github user discovery
contribfestdocumentationgood first issuehelp wanted

Repository metrics

Stars
 (300 stars)
PR merge metrics
 (Avg merge 1h 2m) (1 merged PR in 30d)

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

Contributor guide

Research direction
Investigate crdoc command and its template system to create a custom .tmpl file that excludes core Kubernetes fields such as env valueFrom references.
Tech stack
gokubernetes
Domain
backendinfrastructuredocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoKubernetes
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60