Prepare composite Axon Framework / Axoniq Framework documentation#4420
Open
hatzlj wants to merge 15 commits intoaxon-5.1.xfrom
Open
Prepare composite Axon Framework / Axoniq Framework documentation#4420hatzlj wants to merge 15 commits intoaxon-5.1.xfrom
hatzlj wants to merge 15 commits intoaxon-5.1.xfrom
Conversation
The deadlines guide moves over to AxoniqFramework repository documentation
The saga module (currently unlinked from the main navigation, thus not visible at all) from the reference guide moves over to AxoniqFramework
The dealines module (currently unlinked from the main navigation, thus not visible at all) from the reference guide moves over to AxoniqFramework
hatzlj
added
the
Priority 1: Must
hatzlj
force-pushed
the
documentation/split-framework-documentation
branch
from
12be13f to
443289c
Compare
smcvb
added
the
Type: Documentation
hatzlj
force-pushed
the
documentation/split-framework-documentation
branch
from
443289c to
acf295e
Compare
The Distributed Command Bus moves to Axoniq Framework, so we also move the related documentation, leaving a reference in the Commands > Infrastructure section.
hatzlj
force-pushed
the
documentation/split-framework-documentation
branch
from
acf295e to
2ec9467
Compare
The Dead Letter Queue moves to Axoniq Framework, so we also move the related documentation, leaving a reference in the Events > Event Processors section.
The Axon Server Event Storage Engine moves to Axoniq Framework, so we also move the related documentation, leaving a reference in the Events > Infrastructure section.
The Axon Server Testcontainer facility moves to Axoniq Framework, so we also move the related documentation, leaving a reference in the Testing > Advanced Testing section.
hatzlj
force-pushed
the
documentation/split-framework-documentation
branch
from
2ec9467 to
7c41be9
Compare
To still allow building the Axon Framework documentation locally using antora, we introduce a new playbook source for the axon-framework-reference antora component in `_reference-guide-preview` (keeping `_` in front to filter it for the full library build) that defines the start page and is holding the previous ROOT nav.adoc as main navigation. The playbook.yaml / playbook-dev-ui.yaml are adjusted to include this new source for local builds.
* adjust section naming * restructure extensions section * remove references to Axoniq extensions/modules
The tracing module moves to Axoniq Framework, so we also move the related documentation, leaving references in the Monitoring section
The Distributed Query Bus moves to Axoniq Framework, so we also move the related documentation, leaving a reference in the Queries > Infrastructure section.
The Snapshotting and Caching functionality moves to Axoniq Framework, so we also move the related documentation, leaving references in the Tuning section.
To allow cross-repository builds for Axon Framework and Axoniq Framework documentation without requiring both repositories being on the same branch, we widen the fallback in the antora.yml. For the axoniq-library-site build, a branch filtering is applied to avoid getting feature branches picked up.
hatzlj
force-pushed
the
documentation/split-framework-documentation
branch
from
7c41be9 to
aef51be
Compare
smcvb
requested changes
Apr 17, 2026
Contributor
smcvb
left a comment
smcvb
left a comment
There was a problem hiding this comment.
Some questions, but two concerns:
- I think we should keep the
snapshotting.adocfor now. Let's adjust that once the adjustments are finished - The branch docs don't build for me if I check them out. Due to the bill of materials reference, I think.
|
|
||
| ____ No newline at end of file | ||
| ifdef::advanced-framework[] | ||
| include::axoniq-server-connector:partial$blacklisting-events.adoc[] |
Contributor
There was a problem hiding this comment.
Ow, this features doesn't exist yet/anymore in Axon! Perhaps we should mark it as such.
Contributor
Author
There was a problem hiding this comment.
If it comes back, i would adjust the partial adoc in the AxoniqFramework repository with the admonition we also use in other places where features are missing but will come back.
If not, i would drop the include and related section in the AxoniqFamework docs.
| @@ -1,238 +0,0 @@ | |||
| = Snapshots | |||
Contributor
There was a problem hiding this comment.
The snapshotting.adoc page should, actually, remain. However, we should word it differently... Perhaps we can do this as a follow-up to clearly describe what's Axon Framework and what's Axoniq Framework here.
Contributor
Author
There was a problem hiding this comment.
I will restore it and add a note to our task for moving the snapshotting logic as discussed.
smcvb
approved these changes
Apr 17, 2026
Contributor
smcvb
left a comment
smcvb
left a comment
There was a problem hiding this comment.
Got it building locally now (thanks for the tips...). Structure wise, approved! The sole thing I think we need to keep still, is the snapshotting.adoc. Anticipating you'll get that resolved, I'll preemptively approve this PR
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request removes documentation related to features moving to the Axoniq Framework repository according to our new open source and open core model, as described in this blog in more detail.
More importantly, it also prepares the antora documentation sources for the reference guide to allow us coninuing providing a unified reference guide across all Axon Framework and Axoniq Framework features by merging the documentation of both repositories, while still being able to develop and preview Axon Framework related documentation solely in this repository.
Both Axon Framework (remaining open source) and Axoniq Framework (proprietary open core license) will see 5.1 release end of April, 2026.
For any questions around this pull request, feel free to reach out!