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

Microprofile Server Documentation #4545

Merged
merged 8 commits into from
Jul 20, 2022
Merged

Conversation

tvallin
Copy link
Member

@tvallin tvallin commented Jul 14, 2022

See #4320

Signed-off-by: tvallin thibault.vallin@oracle.com

@tvallin tvallin added the docs label Jul 14, 2022
@tvallin tvallin self-assigned this Jul 14, 2022
@romain-grecourt romain-grecourt marked this pull request as draft July 14, 2022 18:45
Copy link
Contributor

@m0mus m0mus left a comment

Choose a reason for hiding this comment

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

Needs refactoring based on latest @tomas-langer changes in the generation tool such as moving generated docs to /config, using underscores instead of dots in file names, etc.

docs/mp/server.adoc Outdated Show resolved Hide resolved
docs/mp/server.adoc Outdated Show resolved Hide resolved
docs/mp/server.adoc Outdated Show resolved Hide resolved
docs/mp/server.adoc Outdated Show resolved Hide resolved
docs/mp/server.adoc Show resolved Hide resolved
@tvallin tvallin marked this pull request as ready for review July 18, 2022 10:52
@m0mus m0mus self-requested a review July 19, 2022 16:38
m0mus
m0mus previously approved these changes Jul 19, 2022
@m0mus m0mus dismissed tomas-langer’s stale review July 19, 2022 16:39

All comments have been addressed.

Signed-off-by: tvallin <thibault.vallin@oracle.com>
Signed-off-by: tvallin <thibault.vallin@oracle.com>
Signed-off-by: tvallin <thibault.vallin@oracle.com>
Signed-off-by: tvallin <thibault.vallin@oracle.com>
Signed-off-by: tvallin <thibault.vallin@oracle.com>
Signed-off-by: tvallin <thibault.vallin@oracle.com>
Signed-off-by: tvallin <thibault.vallin@oracle.com>
Signed-off-by: tvallin <thibault.vallin@oracle.com>
@tvallin tvallin merged commit 46a8035 into helidon-io:master Jul 20, 2022
@tvallin tvallin deleted the doc_server branch July 20, 2022 12:58
romain-grecourt pushed a commit to MadsBrun/helidon that referenced this pull request Jul 21, 2022
Signed-off-by: tvallin <thibault.vallin@oracle.com>
Copy link
Contributor

@ljamen ljamen left a comment

Choose a reason for hiding this comment

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

Changes LGTM, few edits.

re: title case comments - there is no action at this time. I will follow up with the team.




== Configuration options
Copy link
Contributor

Choose a reason for hiding this comment

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

Check case H2 title case


Helidon MP also supports custom TLS configuration.

User is able to set following properties:
Copy link
Contributor

Choose a reason for hiding this comment

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

You can set the following properties:

- Other ports (in this example we configure one "admin" port) can be assigned endpoints that are exposed by Helidon components,
currently supported by MP Health and MP Metrics

For this example, we will use a `yaml` file:
Copy link
Contributor

Choose a reason for hiding this comment

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

YAML file

routing: "admin"
----

=== Configuring a reactive route
Copy link
Contributor

Choose a reason for hiding this comment

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

title case

You can assign a reactive service to a named routing (and as a result to a named port) using
either an annotation or configuration (or both to override the value from annotation).

====== Annotation `@RoutingName` [[annotation-routing-name]]
Copy link
Contributor

Choose a reason for hiding this comment

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

H6 - is there another way to format this section so that we don't have H6s? We typically stop at H4 but I understand that there are build issues that require a single file now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants