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

Docs: Add custom runtime image guide, maven guide, gradle guide, refactored native image guide. #1639

Merged
merged 7 commits into from
Apr 22, 2020

Conversation

barchetta
Copy link
Member

@barchetta barchetta commented Apr 14, 2020

  1. Add a new guide for custom runtime image creation (MP and SE)
  2. Add new Maven and Gradle build guides. A little sparse for now, but it's a start.
  3. Refactor native image guide to document both SE and MP
  4. Shares content between MP and SE document by putting common content under common and using include and properties to generate edition specific document.
  5. Fixed some typos in WebServer javadocs.

@barchetta barchetta added docs 2.x Issues for 2.x version branch labels Apr 14, 2020
@barchetta barchetta self-assigned this Apr 14, 2020
Copy link
Contributor

@romain-grecourt romain-grecourt left a comment

Choose a reason for hiding this comment

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

Typo in the title of the PR: customer -> custom.
We've been using the term 'flavor' for a while now, I think it's better to rename the *-edition attributes to *-flavor.

@barchetta barchetta changed the title Docs: Add customer runtime image guide, refactored native image guide. Docs: Add custom runtime image guide, refactored native image guide. Apr 14, 2020
docker run --rm -p 8080:8080 helidon-quickstart-{helidon-lc-edition}-jlink:latest
----

You can exercise the application's endpoints as before.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it would also be worth showing passing script arguments, e.g. --test or --help just so it is clear how it is done, (and maybe that the port mappings isn't required).

Copy link
Contributor

@batsatt batsatt left a comment

Choose a reason for hiding this comment

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

We have an open issue (#1391) about the right way to add configuration to the pom for these plugins, say if you want to disable CDS or whatever. Yes, properties work, but they're a bit of a pain. And just pointing to the plugin docs is confusing, since they talk about adding the profile, which is already present now.

It would be best if we could resolve that issue and then show how to do it here.

@barchetta
Copy link
Member Author

We have an open issue (#1391) about the right way to add configuration to the pom for these plugins, say if you want to disable CDS or whatever. Yes, properties work, but they're a bit of a pain. And just pointing to the plugin docs is confusing, since they talk about adding the profile, which is already present now.

It would be best if we could resolve that issue and then show how to do it here.

I've add (an admittedly sparse) Maven Build Guide that shows examples of configuring the plugin and crossed referenced in the jlink guide.

@barchetta barchetta changed the title Docs: Add custom runtime image guide, refactored native image guide. Docs: Add custom runtime image guide, maven guide, gradle guide, refactored native image guide. Apr 15, 2020
batsatt
batsatt previously approved these changes Apr 16, 2020
Copy link
Contributor

@batsatt batsatt left a comment

Choose a reason for hiding this comment

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

LGTM

@barchetta barchetta merged commit d273bc6 into helidon-io:master Apr 22, 2020
@barchetta barchetta deleted the jlink-docs branch June 18, 2020 20:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.x Issues for 2.x version branch docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants