kubernetes / kubernetes/website

Reorganize the "Well-Known Labels, Annotations and Taints" reference page

Open
#31,648 6 comments 0 reactions 0 assignees View on GitHub
kind/feature language/en lifecycle/frozen priority/backlog triage/accepted
Dominant language
HTML
Stars
5.4k
Forks
15.7k
Avg merge
4d 18h
Merged PRs (30d)
204

Description

**This is a Feature Request**

This follows the discussion that took place [here](https://github.com/kubernetes/website/pull/31602#discussion_r798679320).

**What would you like to be added**

- Add the missing "Used on" on entries.
- Specify the complete API group for the resources in "Used on" or reorganize the page into API group categories.
- Remove dependencies between reference entries (like [this one](https://kubernetes.io/docs/reference/labels-annotations-taints/#scheduleralphakubernetesio-preferavoidpods) with the "The taints listed below are always used on Nodes").
- Follow [the style guide for API objects](https://kubernetes.io/docs/contribute/style/style-guide/#inline-code-formatting): use inline code format.

**Why is this needed**
The [Well-Known Labels, Annotations and Taints](https://kubernetes.io/docs/reference/labels-annotations-taints/) reference page is a bit messy at the time. The annotations are not all harmonized with the same template.

Also, new annotations in the kubernetes.io namespace are not targeting Kubernetes API objects. For example, annotations on the audit logs `Event` (from the `audit.k8s.io/v1` API), see #31602 and #31576 for concrete cases.

Finally, there is a certain amount of deprecated labels, annotations and taints that could be moved into a dedicated category.

Contributor guide

Open the contributing guide

Research direction

Start with the Well-Known Labels, Annotations and Taints reference page and review the linked discussion in pull request 31602, along with the API objects style guide. Inventory the entries needing a Used on field, API group details, dependency removal, inline-code formatting, or a deprecated category; done means the page follows a consistent, complete structure.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.