docs: health report first pass #16513
Draft
Conversation
This file contains 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
4 tasks
mashhurs
approved these changes
Oct 7, 2024
There was a problem hiding this comment.
The explanations from technical point of view looks great!
It would be great if we get input from @karenzone for the rest (structure, etc..).
| ======== | ||
|
|
||
| `diagnosis`:: | ||
| (Optional, array) If a non-healthy status is returned, indicators may include a list of diagnosis that encapsulate the cause of the health issue and an action to take in order to remediate the problem. |
There was a problem hiding this comment.
😆 (as a non-native-speaker this is my most-time mistake diagnosis vs diagnoses 🙈)
Suggested change
| (Optional, array) If a non-healthy status is returned, indicators may include a list of diagnosis that encapsulate the cause of the health issue and an action to take in order to remediate the problem. | |
| (Optional, array) If a non-healthy status is returned, indicators may include a list of diagnoses that encapsulate the cause of the health issue and an action to take in order to remediate the problem. |
There was a problem hiding this comment.
This is a verbatim from the Elasticsearch docs 😩
yaauie
commented
Oct 8, 2024
| ======== | ||
|
|
||
| `diagnosis`:: | ||
| (Optional, array) If a non-healthy status is returned, indicators may include a list of diagnosis that encapsulate the cause of the health issue and an action to take in order to remediate the problem. |
There was a problem hiding this comment.
This is a verbatim from the Elasticsearch docs 😩
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.
Release notes
Adds documentation for Health Report API
What does this PR do?
Adds the health report docs that are also added in #16398 as a way of triggering docs CI, which is bypassed in that PR since it targets
feature/*which isn't allowlisted for docs builds.