Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Helidon MP Health new style documentation #4387

Merged
merged 9 commits into from
Jun 20, 2022

Conversation

dalexandrov
Copy link
Contributor

Helidon MP Health new style documentation.
Include generated configuration adoc.

Resolves #4194

@dalexandrov dalexandrov added docs 3.x Issues for 3.x version branch labels Jun 14, 2022
@dalexandrov dalexandrov added this to the 3.0.0 milestone Jun 14, 2022
@dalexandrov dalexandrov self-assigned this Jun 14, 2022
No additional information provided
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would delete the whole "Additional Information" section if its empty.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added information.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although a link to microprofile.io could be useful, it's more useful to add links to MP Health 4.0 and MP Health API repository.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is already a link in the Usage description. Should it be duplicated here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added info to Reference

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a link to Health javadocs?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done)

docs/mp/health/01_introduction.adoc Outdated Show resolved Hide resolved
docs/mp/health/01_introduction.adoc Outdated Show resolved Hide resolved
docs/mp/health/01_introduction.adoc Show resolved Hide resolved
docs/mp/health/01_introduction.adoc Outdated Show resolved Hide resolved
docs/mp/health/01_introduction.adoc Show resolved Hide resolved
docs/mp/health/01_introduction.adoc Outdated Show resolved Hide resolved
docs/mp/health/01_introduction.adoc Outdated Show resolved Hide resolved
docs/mp/health/01_introduction.adoc Outdated Show resolved Hide resolved
docs/mp/health/01_introduction.adoc Outdated Show resolved Hide resolved
docs/mp/health/01_introduction.adoc Outdated Show resolved Hide resolved
Copy link
Member

@tomas-langer tomas-langer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is now ready to be used as a template for others.
There are some issues with the generated file (missing defaults), but that can be resolved later as a part of another PR.

@dalexandrov dalexandrov merged commit c11521a into helidon-io:master Jun 20, 2022
@dalexandrov dalexandrov deleted the 4194_Doc_Helidon_MP_Health branch June 20, 2022 09:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.x Issues for 3.x version branch docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc:] Helidon MP Health
3 participants