-
Notifications
You must be signed in to change notification settings - Fork 6
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 #273 from AxonFramework/move_old_docs_2_library
Move old docs 2 library
- Loading branch information
Showing
9 changed files
with
521 additions
and
5 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,24 @@ | ||
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 | ||
|
||
|
||
AxonIQ.AcronymCase = NO | ||
AxonIQ.HeadingTitle = 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: Reactor Extension docs PREVIEW | ||
start_page: reactor_extension_old_ref::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: reactor_extension_old_ref | ||
title: Reactor Extension Guide | ||
version: true | ||
prerelease: true | ||
start_page: ROOT:index.adoc | ||
|
||
asciidoc: | ||
attributes: | ||
component_description: The Reactor Extension guide from the former reference guide | ||
type: guide | ||
group: axon-framework | ||
|
||
nav: | ||
- modules/nav.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,14 @@ | ||
:navtitle: Reactor Extension | ||
= Reactor | ||
|
||
Overlooking Axon Frameworks architecture, you can notice that in general systems using the framework are "Message Driven", "Responsive", "Resilient" and "Elastic". According to link:https://www.reactivemanifesto.org/[Reactive Manifesto,window=_blank,role=external], the same holds for Reactive Systems in general. | ||
|
||
Although we can state that Axon Framework is a type of reactive system, we can't say that it is fully reactive. | ||
|
||
NOTE: Reactive programming is an approach to writing software that embraces asynchronous I/O. Asynchronous I/O is a small idea that portends big changes for software. The idea is simple: alleviate inefficient resource utilization by reclaiming resources that would otherwise be idle, as they waited for I/O activity. Asynchronous I/O inverts the normal design I/O processing: the clients are notified of new data instead of asking for it, which frees the client to do other work while waiting for these notifications. | ||
|
||
By their nature, a reactive API and Axon are a great fit, as most of framework's operations are async and non-blocking. Providing a dedicated extension for this was thus a logical step to take. To that end, we chose to use Pivotal’s link:https://projectreactor.io/[Project Reactor,window=_blank,role=external] to build this extension. Reactor builds on top of the link:https://www.reactive-streams.org/[Reactive Streams specification,window=_blank,role=external] and is the de-facto standard for Java enterprise and Spring applications. As such, we feel it to be a great fit to provide an extension in, making Axon more reactive. | ||
|
||
NOTE: Not all Axon components offer a reactive API, yet. We will incrementally introduce more "reactiveness" to this extension, giving priority to components where users can benefit the most. | ||
|
||
To use the link:https://github.com/AxonFramework/extension-reactor[Axon Reactor Extension,window=_blank,role=external], make sure that `axon-reactor` module is available on the classpath. |
Oops, something went wrong.