Skip to content

Include a generic Configuration page #4062

@smcvb

Description

@smcvb

Suggested Documentation change

Although Axon's reference guide has snippets per (sub)section explaining how to configure a given component declaratively or in Spring, we would benefit from a more generic Configuration page.

This page should start off with a rough explanation of Axon's configuration, providing a very simple start in Java (perhaps also Kotlin?), plus the needed dependencies (in Maven and Gradle).
From there, we would benefit from providing a list of links to detailed sections. Examples are how to register command handlers, or event processors, or infrastructure components. This list should serve users that aim to quickly find how to configure something in detail.

From there, the Configuration chapter should explain all the layers Axon has, which are:

  1. The ApplicationConfigurer as the component that start the configuration. Provide space for the MessagingConfigurer, ModelingConfigurer, and EventSourcingConfigurer as starting points.
  2. The Configuration as the component the configurer evolves in.
  3. What a Component is and how to use it.
  4. What a ComponentDecorator is and how to use it.
  5. What a ConfigurationEnhancer is and how to use it.
  6. What a Module is and how to use it.
  7. What a ComponentFactory is and how to use it.
  8. How Axon uses the components above to construct the Spring integration.

Metadata

Metadata

Assignees

Labels

Priority 1: MustHighest priority. A release cannot be made if this issue isn’t resolved.

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions