Skip to content

docs: improve discoverability of health checks how-to guide - #931

Open
chapman-von-monty wants to merge 1 commit into
canonical:masterfrom
chapman-von-monty:docs/improve-discoverability-health-checks
Open

docs: improve discoverability of health checks how-to guide#931
chapman-von-monty wants to merge 1 commit into
canonical:masterfrom
chapman-von-monty:docs/improve-discoverability-health-checks

Conversation

@chapman-von-monty

@chapman-von-monty chapman-von-monty commented Sep 4, 2026

Copy link
Copy Markdown

Analytics showed that the reference page for health checks received
significantly more traffic than the how-to guide "How to run services
reliably", despite the how-to guide being positioned second in the section.
The page title and navigation lacked mention of health checks, making it
difficult to discover for users searching for check configuration and
service auto-restart behavior.

This improves the discoverability of the guide by:

  1. Renaming the page title to "How to run services reliably with health checks"
    and the table of contents entry to "Configure health checks to run services
    reliably".
  2. Adding an upfront callout under ## Usage in reference/health-checks.md
    and making the link under See also explicit.
  3. Adding a cross-reference in reference/service-auto-restart.md pointing to
    the health check restart guide.
  4. Featuring the guide on the documentation homepage in docs/index.md.
  5. Linking to the guide under Next steps in the tutorial getting started doc.

Fixes #864

@hpidcock

hpidcock commented Sep 8, 2026

Copy link
Copy Markdown
Member

@dwilding my bot has had an attempt at #864, can you please review it so I can either have it try again or improve it's SOUL.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve discoverability of "how to run services reliably" doc

2 participants