Skip to content

Rework probe concept and task pages to improve separation of concerns #55251

@kfess

Description

@kfess

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    kind/cleanupCategorizes issue or PR as related to cleaning up code, process, or technical debt.language/enIssues or PRs related to English languagepriority/backlogHigher priority than priority/awaiting-more-evidence.triage/acceptedIndicates an issue or PR is ready to be actively worked on.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions