kubernetes / kubernetes/kubectl

`kubectl explain -o md`

Open
#1,419 30 comments 1 reaction 0 assignees View on GitHub
kind/feature needs-triage sig/api-machinery sig/cli
Dominant language
Go
Stars
3.3k
Forks
1k
PR merge metrics
No merged PRs in 30d

Description

**What would you like to be added**:
Markdown documentation export from a CRD using `kubectl explain -o md`
And ideally it would accept -i /path/to/local/crd.yaml

**Why is this needed**:
For auto generated documentation of an Custom Resource to markdown/html formats.

Contributor guide

Open the contributing guide

Research direction

Start at the kubectl explain entry point and run the existing command against a CRD to understand its current output and resource lookup behavior. Trace how a CRD is loaded, including the proposed local crd.yaml path, and define the Markdown output shape. Done means explain supports -o md and, if included, -i for local CRDs with usable generated documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, kubernetes
Domain
cli, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.