SE and MP Health Guides

[pfmackin]

This is the first pass at a new SE and MP Health Guide

[romain-grecourt]

LGTM, can you also add a new card in the guides overview ?

[pfmackin]

I can do that but there was some discussion between Joe and Mark about refactoring the structure. Anyway, I will do that for now.

This is done

[romain-grecourt]

Thanks, at least the guide can fit nicely until we re-work the guides overview.

[romain-grecourt]

Couple of thoughts.

The guide seems a little long, maybe we can cut the length by removing the JSON snippets for the expected outputs.

I think we should update the quickstart YAML file to add what's missing and documented in this guide (separate PR).

Note that I'm working on a bare archetype, when that's ready we can update this guide (separate) to use it.

[markxnelson]

I don't think it is too long - I think some of the other existing ones are too short - they leave out vital information that a person who is not already familiar with Helidon (or MP) would actually need imho.

[pfmackin]

I can do whatever you folks want regarding the JSON. I personally like a guide to be something that a user can cut and paste into and IDE, build, run, and verify that the output is correct.

[romain-grecourt]

There aren't many other guides to compare the length to. Quickstart and meant to be "quick", the other ones are not really comparable.

The current angle for the guides is less to explain and more to exercise ; we should try to avoid overlapping with the "normal" docs.

[m0mus]

Most my comments for MP guide are valid for SE guide as well. Please fix it in both guides.

[m0mus]

@romain-grecourt A guide should contain enough to get started with some specific topic without looking on normal docs. It may contain links to documentation if users want to go deeper in the topic.

[romain-grecourt]

@m0mus I disagree, but there is no need to argue any further.

[ljamen]

This tutorial describes how to create a sample MicroProfile (MP) project that can be used to run some basic examples using both built-in and custom health-checks with Helidon MP.

[ljamen]

The following example will

[ljamen]

with the following contents:

[barchetta]

@pfmackin currently the health wire response provides both outcome/state and status. Outcome and state were replaced by status in MicroProfile Health 2.0. So use of outcome and state are deprecated. I think this should be mentioned in the guide. Maybe a tip or note like:

In MicroProfile Health 2.0 outcome and state were replaced by status in the JSON response wire format. Helidon currently provides both fields for backwards compatibility, but use of outcome and state is deprecated and will be removed in a future release. You should rely on state instead.

I think this might also apply to Helidon SE health. You might want to confirm with @tomas-langer

[pfmackin]

I fixed this in MP. SE doesn't return status, it just returns state and outcome.

[m0mus]

LGTM