Skip to content

Commit

Permalink
MULTI-REPO_COMMIT: Move all extension reference guides to their desig…
Browse files Browse the repository at this point in the history
…nated page and rename README.adoc to index.adoc for friendlier URLS.

Many small changes based on build output have also been done over many repositories. Some parts needed escaping, didn't have proper syntax, or headers that should really be tabs.
  • Loading branch information
CodeDrivenMitch committed Oct 3, 2024
1 parent bc50ff1 commit 5a263e2
Show file tree
Hide file tree
Showing 9 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This folder contains the docs related to the MongoDB Extension for Axon Framewor

The following are the current documentation sources (folders):

- `extension-guide` : [The MongoDB Extension Guide](https://library.axoniq.io/mongodb_extension_guide/index.html)
- `extension-guide` : [The MongoDB Extension Guide](https://library.axoniq.io/mongodb-extension-reference/index.html)

## Contributing to the docs.

Expand Down
2 changes: 1 addition & 1 deletion docs/_playbook/playbook.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
site:
title: MongoDB Extension docs PREVIEW
start_page: mongodb_extension_guide::index.adoc
start_page: mongodb-extension-reference::index.adoc

content:
sources:
Expand Down
14 changes: 0 additions & 14 deletions docs/extension-guide/antora.yml

This file was deleted.

14 changes: 14 additions & 0 deletions docs/reference/antora.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: mongodb-extension-reference
title: MongoDB Extension Reference
version: true
prerelease: true
start_page: ROOT:index.adoc

asciidoc:
attributes:
component_description: Extension adding MongoDB integration for all Axon Framework components requiring storage
type: extension-reference
group: axon-framework

nav:
- modules/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:navtitle: Configuration of the MongoDB Dead-Letter Queue with Spring
= Configuration of the MongoDB Dead-Letter Queue with Spring

See xref:axon-framework-reference:events:event-processors/README.adoc#dead-letter-queue[Dead-Letter Queue] for the general information about the Dead-Letter Queue.
See xref:axon-framework-reference:events:event-processors/index.adoc#dead-letter-queue[Dead-Letter Queue] for the general information about the Dead-Letter Queue.

[source,java]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ Put a (unique) index on the `"sagaIdentifier"` in the saga (default name: `"saga

Put a (unique) index on the combination of `"processingGroup"`, `"sequenceIdentifier"` and `"index"` in the dead letter (default name: `"deadletters"`) collection. Put an index on the `"processingGroup"`, and `"sequenceIdentifier"` properties in the dead letter (default name: `"deadletters"`) collection. Put an index on the `"processingGroup"` property in the dead letter (default name: `"deadletters"`) collection.

NOTE: In pre Axon Framework 3 release we found MongoDb to be a good fit as an Event Store. However, with the introduction of Tracking Event Processors and how they track their events, we have encountered some inefficiencies regarding the Mongo Event Store implementation. We recommend using a built-for-purpose event store like xref:axon_server_ref:ROOT:index.adoc[Axon Server], or alternatively an RDBMS based (the JPA or JDBC implementations for example), and would only suggest to use Mongo for this use case if you have found its performance to be beneficial for your application.
NOTE: In pre Axon Framework 3 release we found MongoDb to be a good fit as an Event Store. However, with the introduction of Tracking Event Processors and how they track their events, we have encountered some inefficiencies regarding the Mongo Event Store implementation. We recommend using a built-for-purpose event store like xref:axon-server-reference:ROOT:index.adoc[Axon Server], or alternatively an RDBMS based (the JPA or JDBC implementations for example), and would only suggest to use Mongo for this use case if you have found its performance to be beneficial for your application.
File renamed without changes.

0 comments on commit 5a263e2

Please sign in to comment.