kubernetes/website

Document conditions as a Kubernetes concept

Open

#41,065 opened on May 10, 2023

View on GitHub
 (15 comments) (6 reactions) (2 assignees)HTML (13,918 forks)batch import
help wantedkind/featurelanguage/enlifecycle/frozenpriority/backlogsig/architecturetriage/accepted

Repository metrics

Stars
 (4,127 stars)
PR merge metrics
 (Avg merge 16d 13h) (160 merged PRs in 30d)

Description

This is a Feature Request

What would you like to be added

  • Add a page, or section of an existing page, about conditions in Kubernetes
    • Ideally, also mention reasons.
  • Add a glossary entry that references that section

Extra credit: revise existing mentions such as https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-conditions to use a glossary tooltip for the new entry.

Why is this needed People might want to know what conditions are. Docs authors might want to use a glossary tooltip for condition rather than explain each time.

Comments Not sure what conditions are? Please read - but don't plagiarize - https://maelvls.dev/kubernetes-conditions/

/language en /priority backlog /lifecycle frozen /sig architecture

Contributor guide

Research direction
Create a new page documenting Kubernetes conditions and reasons, ensuring to use glossary tooltips where applicable.
Tech stack
None
Domain
documentation
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70