Skip to content

Commit d4c729e

Browse files
dgomezgdgomezg
authored
Merge pull request #169 from AxonFramework/move_old_docs_2_library
Move old docs 2 library
2 parents 325c66b + 92065be commit d4c729e

File tree

10 files changed

+131
-6
lines changed

10 files changed

+131
-6
lines changed

‎README.md‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,19 @@ For more information on anything Axon, please visit our website, [http://axoniq.
2323

2424
## Getting started
2525

26-
The [reference guide](https://docs.axoniq.io) contains a separate chapter for all the extensions.
27-
The Spring Native extension description can be
28-
found [here](https://docs.axoniq.io/reference-guide/extensions/spring-aot).
26+
The [AxonIQ Library](https://library.axoniq.io) contains a section for the guides of all the Axon Framework extensions.
27+
The Spring AOT extension guide can be found [here](https://library.axoniq.io/home/guides/axon-framework.html).
2928

3029
## Receiving help
3130

3231
Are you having trouble using the extension?
3332
We'd like to help you out the best we can!
3433
There are a couple of things to consider when you're traversing anything Axon:
3534

36-
* Checking the [reference guide](https://docs.axoniq.io/reference-guide/extensions/spring-aot) should be your first
37-
stop,
35+
* Checking the [reference guide](https://library.axoniq.io/axon_framework_old_ref/) should be your first stop,
3836
as the majority of possible scenarios you might encounter when using Axon should be covered there.
3937
* If the Reference Guide does not cover a specific topic you would've expected,
40-
we'd appreciate if you could file an [issue](https://github.com/AxonIQ/reference-guide/issues) about it for us.
38+
we'd appreciate if you could post a [new thread/topic on our library fourms describing the problem](https://discuss.axoniq.io/c/26).
4139
* There is a [forum](https://discuss.axoniq.io/) to support you in the case the reference guide did not sufficiently answer your question.
4240
Axon Framework and Server developers will help out on a best effort basis.
4341
Know that any support from contributors on posted question is very much appreciated on the forum.

‎docs/_playbook/.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
build
2+
node_modules
3+
.vscode
4+
vale
5+
package-lock.json

‎docs/_playbook/.vale.ini‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
StylesPath = vale
2+
3+
MinAlertLevel = suggestion
4+
5+
Packages = http://github.com/AxonIQ/axoniq-vale-package/releases/latest/download/axoniq-vale-package.zip
6+
7+
Vocab = general, AxonIQ, Java, Names_Terms, misc
8+
9+
[*.{adoc,html}]
10+
BasedOnStyles = AxonIQ, proselint, Google
11+
12+
Google.Headings = NO # Diasable in favor od AxonIQ one
13+
Google.Parens = NO # Disable warning about using parens
14+
Google.Quotes = NO # Diasable "commas and periods go inside quotation marks"
15+
Google.WordList = NO # Disable Google's word list
16+
Google.Passive = NO # Allow the use of Passive voice
17+
Google.Colons = NO # Allow the use of Colons
18+
Google.Will = NO # Allow use will
19+
Google.Contractions = NO
20+
Google.We = NO
21+
22+
23+

‎docs/_playbook/package.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"devDependencies": {
3+
"@antora/atlas-extension": "^1.0.0-alpha.2",
4+
"@antora/cli": "^3.2.0-alpha.2",
5+
"@antora/lunr-extension": "^1.0.0-alpha.8",
6+
"@antora/site-generator": "^3.2.0-alpha.2",
7+
"@asciidoctor/tabs": "^1.0.0-beta.6",
8+
"@axoniq/antora-vale-extension": "^0.1.1",
9+
"asciidoctor-kroki": "^0.17.0"
10+
}
11+
}

‎docs/_playbook/playbook.yaml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
site:
2+
title: Spring AOT Extension docs PREVIEW
3+
start_page: springaot_extension_guide::index.adoc
4+
5+
content:
6+
sources:
7+
- url: ../..
8+
start_paths: ['docs/*', '!docs/_*']
9+
10+
asciidoc:
11+
attributes:
12+
experimental: true
13+
page-pagination: true
14+
kroki-fetch-diagram: true
15+
# primary-site-manifest-url: https://library.axoniq.io/site-manifest.json
16+
extensions:
17+
- asciidoctor-kroki
18+
- '@asciidoctor/tabs'
19+
20+
antora:
21+
extensions:
22+
- id: prose-linting
23+
require: '@axoniq/antora-vale-extension'
24+
enabled: true
25+
vale_config: .vale.ini
26+
update_styles: true
27+
- id: lunr
28+
require: '@antora/lunr-extension'
29+
enabled: true
30+
index_latest_only: true
31+
- id: atlas
32+
require: '@antora/atlas-extension'
33+
34+
runtime:
35+
fetch: true # fetch remote repos
36+
log:
37+
level: info
38+
failure_level: error
39+
40+
ui:
41+
bundle:
42+
url: https://github.com/AxonIQ/axoniq-library-ui/releases/download/v.0.1.10/ui-bundle.zip

‎docs/extension-guide/antora.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: springaot_extension_guide
2+
title: Spring AOT Extension Guide
3+
version: true
4+
prerelease: true
5+
start_page: ROOT:index.adoc
6+
7+
asciidoc:
8+
attributes:
9+
component_description: The Spring AOT Extension guide from the former reference guide
10+
type: guide
11+
group: axon-framework
12+
13+
nav:
14+
- modules/nav.adoc

‎docs/extension-guide/modules/ROOT/pages/compile-to-native.adoc‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
:navtitle: Compiling to Native
2+
= Compiling to Native
3+
4+
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:
5+
6+
7+
[sources,xml]
8+
----
9+
<dependency>
10+
<groupId>org.axonframework.extensions.spring-aot</groupId>
11+
<artifactId>axon-spring-aot</artifactId>
12+
<version>4.8.0</version>
13+
</dependency>
14+
----
15+
16+
This should be enough to have additional hints with ahead of time compilation to successfully build and run your Axon application.
17+

‎docs/extension-guide/modules/ROOT/pages/index.adoc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
:navtitle: Spring Ahead of Time
2+
= Spring Ahead of Time
3+
4+
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.
5+
6+
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.
7+
8+
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].

‎docs/extension-guide/modules/ROOT/pages/performance.adoc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
:navtitle: Performance Tips
2+
= Performance Tips
3+
4+
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.

‎docs/extension-guide/modules/nav.adoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
* xref::index.adoc[]
2+
** xref::compile-to-native.adoc[]
3+
** xref::performance.adoc[]

0 commit comments

Comments
 (0)