-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #169 from AxonFramework/move_old_docs_2_library
Move old docs 2 library
- Loading branch information
Showing
10 changed files
with
131 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
build | ||
node_modules | ||
.vscode | ||
vale | ||
package-lock.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
StylesPath = vale | ||
|
||
MinAlertLevel = suggestion | ||
|
||
Packages = http://github.com/AxonIQ/axoniq-vale-package/releases/latest/download/axoniq-vale-package.zip | ||
|
||
Vocab = general, AxonIQ, Java, Names_Terms, misc | ||
|
||
[*.{adoc,html}] | ||
BasedOnStyles = AxonIQ, proselint, Google | ||
|
||
Google.Headings = NO # Diasable in favor od AxonIQ one | ||
Google.Parens = NO # Disable warning about using parens | ||
Google.Quotes = NO # Diasable "commas and periods go inside quotation marks" | ||
Google.WordList = NO # Disable Google's word list | ||
Google.Passive = NO # Allow the use of Passive voice | ||
Google.Colons = NO # Allow the use of Colons | ||
Google.Will = NO # Allow use will | ||
Google.Contractions = NO | ||
Google.We = NO | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
{ | ||
"devDependencies": { | ||
"@antora/atlas-extension": "^1.0.0-alpha.2", | ||
"@antora/cli": "^3.2.0-alpha.2", | ||
"@antora/lunr-extension": "^1.0.0-alpha.8", | ||
"@antora/site-generator": "^3.2.0-alpha.2", | ||
"@asciidoctor/tabs": "^1.0.0-beta.6", | ||
"@axoniq/antora-vale-extension": "^0.1.1", | ||
"asciidoctor-kroki": "^0.17.0" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
site: | ||
title: Spring AOT Extension docs PREVIEW | ||
start_page: springaot_extension_guide::index.adoc | ||
|
||
content: | ||
sources: | ||
- url: ../.. | ||
start_paths: ['docs/*', '!docs/_*'] | ||
|
||
asciidoc: | ||
attributes: | ||
experimental: true | ||
page-pagination: true | ||
kroki-fetch-diagram: true | ||
# primary-site-manifest-url: https://library.axoniq.io/site-manifest.json | ||
extensions: | ||
- asciidoctor-kroki | ||
- '@asciidoctor/tabs' | ||
|
||
antora: | ||
extensions: | ||
- id: prose-linting | ||
require: '@axoniq/antora-vale-extension' | ||
enabled: true | ||
vale_config: .vale.ini | ||
update_styles: true | ||
- id: lunr | ||
require: '@antora/lunr-extension' | ||
enabled: true | ||
index_latest_only: true | ||
- id: atlas | ||
require: '@antora/atlas-extension' | ||
|
||
runtime: | ||
fetch: true # fetch remote repos | ||
log: | ||
level: info | ||
failure_level: error | ||
|
||
ui: | ||
bundle: | ||
url: https://github.com/AxonIQ/axoniq-library-ui/releases/download/v.0.1.10/ui-bundle.zip |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
name: springaot_extension_guide | ||
title: Spring AOT Extension Guide | ||
version: true | ||
prerelease: true | ||
start_page: ROOT:index.adoc | ||
|
||
asciidoc: | ||
attributes: | ||
component_description: The Spring AOT Extension guide from the former reference guide | ||
type: guide | ||
group: axon-framework | ||
|
||
nav: | ||
- modules/nav.adoc |
17 changes: 17 additions & 0 deletions
17
docs/extension-guide/modules/ROOT/pages/compile-to-native.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
:navtitle: Compiling to Native | ||
= Compiling to Native | ||
|
||
Before you set up this extension, it's important to read through the link:https://docs.spring.io/spring-boot/docs/current/reference/html/native-image.html[documentation,window=_blank,role=external] from Spring itself. There are some known limitations that might require additional changes to the application. In addition, this extension needs to be added by adding the following dependency: | ||
|
||
|
||
[sources,xml] | ||
---- | ||
<dependency> | ||
<groupId>org.axonframework.extensions.spring-aot</groupId> | ||
<artifactId>axon-spring-aot</artifactId> | ||
<version>4.8.0</version> | ||
</dependency> | ||
---- | ||
|
||
This should be enough to have additional hints with ahead of time compilation to successfully build and run your Axon application. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
:navtitle: Spring Ahead of Time | ||
= Spring Ahead of Time | ||
|
||
link:https://docs.spring.io/spring-boot/docs/current/reference/html/native-image.html#native-image.introducing-graalvm-native-images.understanding-aot-processing[Spring AOT processing,window=_blank,role=external] is part of the process to create a native binary from a Spring (Boot) application. This extension will help in adding a lot of hints which are needed for Axon Framework. Please note this extension can only be used with Spring Boot 3, as such it requires at least Java 17. | ||
|
||
Besides the extension, it might be necessary to make more changes to successfully compile and run an application as a native image. For example, when a message isn't used in a handler. This is quite common when the application is split, and the application sending certain messages is not the same as the application handling the messages. In those cases these messages need to be added to the link:https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/context/annotation/ImportRuntimeHints.html[`ImportRuntimeHints`,window=_blank,role=external] annotation. Otherwise, these messages can't be deserialized, leading to errors at runtime. | ||
|
||
If something is not working or only works with additional hints, and it's Axon-specific, please let us know either at link:https://github.com/AxonFramework/extension-spring-aot/issues[GitHub,window=_blank,role=external] or link:https://discuss.axoniq.io/c/axonframework/[Discuss,window=_blank,role=external]. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
:navtitle: Performance Tips | ||
= Performance Tips | ||
|
||
It can be beneficial to move from JPA implementations to JDBC implementations. This likely decreases both the time it takes to compile the image and the time to start the image. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
* xref::index.adoc[] | ||
** xref::compile-to-native.adoc[] | ||
** xref::performance.adoc[] |