docs: improve discoverability of health checks how-to guide - #931
Open
chapman-von-monty wants to merge 1 commit into
Open
docs: improve discoverability of health checks how-to guide#931chapman-von-monty wants to merge 1 commit into
chapman-von-monty wants to merge 1 commit into
Conversation
Member
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
and the table of contents entry to "Configure health checks to run services
reliably".
## Usageinreference/health-checks.mdand making the link under
See alsoexplicit.reference/service-auto-restart.mdpointing tothe health check restart guide.
docs/index.md.Next stepsin the tutorial getting started doc.Fixes #864