Document Leyden AOT use in Quarkus#52596
Conversation
geoand
force-pushed
the
docs-leyden-aot
branch
8 times, most recently
from
a0b9f73 to
20b4ad1
Compare
|
🙈 The PR is closed and the preview is expired. |
geoand
force-pushed
the
docs-leyden-aot
branch
from
20b4ad1 to
ad6ba94
Compare
This comment has been minimized.
This comment has been minimized.
geoand
changed the title
docs/src/main/asciidoc/aot.adoc
Outdated
| To use the `aot-jar` packaging: | ||
|
|
||
| [source,bash] | ||
| ---- | ||
| ./mvnw package -Dquarkus.package.jar.type=aot-jar | ||
| ---- | ||
|
|
||
| Or configure it in `application.properties`: | ||
|
|
||
| [source,properties] | ||
| ---- | ||
| quarkus.package.jar.type=aot-jar | ||
| ---- |
There was a problem hiding this comment.
I would rather avoid this section and say something like: 'It is not recommended to use the aot-jar packaging outside of the AOT use case, as the fast-jar packaging offers a lot more optimizations for the non-AOT case.'
docs/src/main/asciidoc/aot.adoc
Outdated
| 1. Build your application with `aot-jar` packaging | ||
| 2. Create a base container image | ||
| 3. Run integration tests to train the AOT cache | ||
| 4. Create a new container image (with `-aot` suffix) that includes the AOT cache, pre-configured to use it |
There was a problem hiding this comment.
I think it should be clear it's the version that is suffixed, not the container image name.
| This guide explains how to leverage JDK's Ahead-of-Time (AOT) caching capabilities in Quarkus to achieve significantly faster application startup times. | ||
|
|
There was a problem hiding this comment.
I think we should add more explanation as to what it is and why it's faster: reducing the class loading burden by having a cache of loaded and linked classes.
Maybe we can also explain the method profiling.
I wouldn't expect people to be very familiar with it, if we want to make it more popular.
I also think we should state that it's still a JVM application and maybe have a comparison of native vs AOT.
We can still add all this later if you're not comfortable doing it now.
Or maybe we should have a Packaging guide that explain how you can package your application and the various approaches.
There was a problem hiding this comment.
For the time being, I don't want to add much information and I would rather wait for the blog post series from the JDK team and then link to it.
There was a problem hiding this comment.
Or maybe we should have a Packaging guide that explain how you can package your application and the various approaches.
Yeah, I think this makes sense as a next step
Co-authored-by: Guillaume Smet <guillaume.smet@gmail.com>
geoand
force-pushed
the
docs-leyden-aot
branch
from
7ef6408 to
b16d510
Compare
|
Thanks for the review! PR updated |
Status for workflow
|
gsmet
left a comment
gsmet
left a comment
There was a problem hiding this comment.
Let's get this in and I will update it once we manage to get the default value in.
|
Same for the Gradle stuff |
|
🤖 Automatically associated with the WG - AOT Support Working Group based on AI classification. |
3 participants
This PR restructures the AppCDS documentation to focus on Leyden AOT as the primary feature.