kubernetes / kubernetes/website

Improvement for k8s.io/docs/reference/kubectl/generated/kubectl_get/

Open
#56,019 3 comments 0 reactions 0 assignees View on GitHub
needs-triage
Dominant language
HTML
Stars
5.4k
Forks
15.7k
Avg merge
4d 18h
Merged PRs (30d)
204

Description

There seems to be no information to explain what data is shown in each column of the output.

I would expect it, in the reference documentation. Or, at least a link to a page that explains the output.

(Note: that docs reference page is auto-generated)

Contributor guide

Open the contributing guide

Research direction

Start at k8s.io/docs/reference/kubectl/generated/kubectl_get/ and trace how this auto-generated reference page is produced. Check the existing kubectl get output documentation and its generation source to determine where a column explanation or link belongs. Done means the reference page provides clear information about the output columns without requiring undocumented context.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.