-
Notifications
You must be signed in to change notification settings - Fork 15.4k
Rework probe concept and task pages to improve separation of concerns #55251
Copy link
Copy link
Open
Labels
kind/cleanupCategorizes issue or PR as related to cleaning up code, process, or technical debt.Categorizes issue or PR as related to cleaning up code, process, or technical debt.language/enIssues or PRs related to English languageIssues or PRs related to English languagepriority/backlogHigher priority than priority/awaiting-more-evidence.Higher priority than priority/awaiting-more-evidence.triage/acceptedIndicates an issue or PR is ready to be actively worked on.Indicates an issue or PR is ready to be actively worked on.
Description
This is a Feature Request
What would you like to be added
IMO, the current concept page for probes seems thin, while the task page 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 #54960
/assign
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
kind/cleanupCategorizes issue or PR as related to cleaning up code, process, or technical debt.Categorizes issue or PR as related to cleaning up code, process, or technical debt.language/enIssues or PRs related to English languageIssues or PRs related to English languagepriority/backlogHigher priority than priority/awaiting-more-evidence.Higher priority than priority/awaiting-more-evidence.triage/acceptedIndicates an issue or PR is ready to be actively worked on.Indicates an issue or PR is ready to be actively worked on.