From 5a263e237935a7b1ccc747b0d928e900764f5757 Mon Sep 17 00:00:00 2001 From: Mitchell Herrijgers Date: Thu, 3 Oct 2024 16:15:18 +0100 Subject: [PATCH] MULTI-REPO_COMMIT: Move all extension reference guides to their designated 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. --- docs/README.md | 2 +- docs/_playbook/playbook.yaml | 2 +- docs/extension-guide/antora.yml | 14 -------------- docs/reference/antora.yml | 14 ++++++++++++++ .../modules/ROOT/pages/dlq-spring-config.adoc | 2 +- .../modules/ROOT/pages/index.adoc | 2 +- .../modules/ROOT/pages/spring-config.adoc | 0 .../modules/ROOT/pages/springboot-config.adoc | 0 .../modules/nav.adoc | 0 9 files changed, 18 insertions(+), 18 deletions(-) delete mode 100644 docs/extension-guide/antora.yml create mode 100644 docs/reference/antora.yml rename docs/{extension-guide => reference}/modules/ROOT/pages/dlq-spring-config.adoc (87%) rename docs/{extension-guide => reference}/modules/ROOT/pages/index.adoc (88%) rename docs/{extension-guide => reference}/modules/ROOT/pages/spring-config.adoc (100%) rename docs/{extension-guide => reference}/modules/ROOT/pages/springboot-config.adoc (100%) rename docs/{extension-guide => reference}/modules/nav.adoc (100%) diff --git a/docs/README.md b/docs/README.md index 63c3fa8..b3bec6b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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. diff --git a/docs/_playbook/playbook.yaml b/docs/_playbook/playbook.yaml index 4a49284..6b74a78 100644 --- a/docs/_playbook/playbook.yaml +++ b/docs/_playbook/playbook.yaml @@ -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: diff --git a/docs/extension-guide/antora.yml b/docs/extension-guide/antora.yml deleted file mode 100644 index eb567d6..0000000 --- a/docs/extension-guide/antora.yml +++ /dev/null @@ -1,14 +0,0 @@ -name: mongodb_extension_guide -title: MongoDB Extension Guide -version: true -prerelease: true -start_page: ROOT:index.adoc - -asciidoc: - attributes: - component_description: The MongoDB Extension guide from the former reference guide - type: guide - group: axon-framework - -nav: - - modules/nav.adoc \ No newline at end of file diff --git a/docs/reference/antora.yml b/docs/reference/antora.yml new file mode 100644 index 0000000..d52c587 --- /dev/null +++ b/docs/reference/antora.yml @@ -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 \ No newline at end of file diff --git a/docs/extension-guide/modules/ROOT/pages/dlq-spring-config.adoc b/docs/reference/modules/ROOT/pages/dlq-spring-config.adoc similarity index 87% rename from docs/extension-guide/modules/ROOT/pages/dlq-spring-config.adoc rename to docs/reference/modules/ROOT/pages/dlq-spring-config.adoc index b739307..3673662 100644 --- a/docs/extension-guide/modules/ROOT/pages/dlq-spring-config.adoc +++ b/docs/reference/modules/ROOT/pages/dlq-spring-config.adoc @@ -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] ---- diff --git a/docs/extension-guide/modules/ROOT/pages/index.adoc b/docs/reference/modules/ROOT/pages/index.adoc similarity index 88% rename from docs/extension-guide/modules/ROOT/pages/index.adoc rename to docs/reference/modules/ROOT/pages/index.adoc index c5881c1..b50cf22 100644 --- a/docs/extension-guide/modules/ROOT/pages/index.adoc +++ b/docs/reference/modules/ROOT/pages/index.adoc @@ -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. diff --git a/docs/extension-guide/modules/ROOT/pages/spring-config.adoc b/docs/reference/modules/ROOT/pages/spring-config.adoc similarity index 100% rename from docs/extension-guide/modules/ROOT/pages/spring-config.adoc rename to docs/reference/modules/ROOT/pages/spring-config.adoc diff --git a/docs/extension-guide/modules/ROOT/pages/springboot-config.adoc b/docs/reference/modules/ROOT/pages/springboot-config.adoc similarity index 100% rename from docs/extension-guide/modules/ROOT/pages/springboot-config.adoc rename to docs/reference/modules/ROOT/pages/springboot-config.adoc diff --git a/docs/extension-guide/modules/nav.adoc b/docs/reference/modules/nav.adoc similarity index 100% rename from docs/extension-guide/modules/nav.adoc rename to docs/reference/modules/nav.adoc