kubernetes / kubernetes/website

Rework probe concept and task pages to improve separation of concerns

Open
#55,251 8 comments 0 reactions 1 assignee Claimed by @kfess View on GitHub
kind/cleanup language/en 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**

**What would you like to be added**

IMO, the current [concept page](https://kubernetes.io/docs/concepts/configuration/liveness-readiness-startup-probes/) for probes seems thin, while the [task page](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) contains a fair amount of conceptual content and relatively new feature gate information (Probe-level terminationGracePeriodSeconds). I'd like to try to rework both pages.

move to the concept page (suggestion):
- Caution and Note callouts currently in the task page
- Overview of probe mechanisms (exec, httpGet, ...)
- A simple yaml to explain probe structure
- (key configuration fields?)
- and replace the current long introduction with a brief sentence in the task page

**Why is this needed**

The concept page currently does not explain probe mechanisms or key fields at all. On the other hand,
the task page duplicates conceptual content that could belong to concept page. Readers coming from the concept page have to go to task page for almost all the details.

**Comment**
IMO, this is a follow up of https://github.com/kubernetes/website/pull/54960

/assign

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.