kubernetes / kubernetes/website

Move most of the CRD documentation currently under 'tasks' to 'concepts'

Open
#35,991 13 comments 3 reactions 0 assignees View on GitHub
kind/cleanup kind/feature language/en lifecycle/frozen triage/accepted wg/api-expression
Dominant language
HTML
Stars
5.4k
Forks
15.7k
Avg merge
4d 18h
Merged PRs (30d)
204

Description

**This is a Feature Request**

While discussing a CRD feature promotion blog post, @sftim [noticed](https://github.com/kubernetes/website/pull/35459/files#r943854829) that we're primarly documenting CRD in the "tasks" section of the documentation, but most of the documentation is about CRD concepts, which are [underdocumented](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) in concepts.

**What would you like to be added**

I would like find a way to reorganize the content.

**Why is this needed**

Make information about CRDs easier to find.
Improve consistency of documentation.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the CRD documentation under the tasks section and the existing concepts page at concepts/extend-kubernetes/api-extension/custom-resources/. Identify which material explains concepts rather than procedures, then reorganize it so CRD information is easier to find and the concepts and tasks sections are consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.