From 2f5549da7579a89b46ec2ebb7c67192dd8520a5c Mon Sep 17 00:00:00 2001 From: Karsten Silz <1061209+ksilz@users.noreply.github.com> Date: Wed, 26 Oct 2022 08:51:00 +0200 Subject: [PATCH] GH-59 - Fixed typos in reference documentation. "ApplicationEventPublisher" is the class in the sample code, not "ApplicationEventListener". Clarified default serialization. --- src/docs/asciidoc/40-events.adoc | 4 ++-- src/docs/asciidoc/60-documentation.adoc | 2 +- src/docs/asciidoc/70-observability.adoc | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/docs/asciidoc/40-events.adoc b/src/docs/asciidoc/40-events.adoc index 4c6e03df..e25a5fd1 100644 --- a/src/docs/asciidoc/40-events.adoc +++ b/src/docs/asciidoc/40-events.adoc @@ -32,7 +32,7 @@ It also means that we will have to touch the class whenever we would like to int We can change the application module interaction as follows: -.Publishing an application event via Spring's `ApplicationEventListener` +.Publishing an application event via Spring's `ApplicationEventPublisher` [source, java] ---- @Service @@ -109,7 +109,7 @@ For details, please consult the <> in the app Each log entry contains the original event in serialized form. The `EventSerializer` abstraction contained in `spring-modulith-events-core` allows plugging different strategies for how to turn the event instances into a format suitable for the datastore. -Spring Modulith provides a Jackson based implementation through the `spring-modulith-events-jackson` artifact, which registers a `JacksonEventSerializer` consuming an `ObjectMapper` through standard Spring Boot auto-configuration by default. +Spring Modulith provides a Jackson-based JSON implementation through the `spring-modulith-events-jackson` artifact, which registers a `JacksonEventSerializer` consuming an `ObjectMapper` through standard Spring Boot auto-configuration by default. [[events.starters]] == Spring Boot Event Registry Starters diff --git a/src/docs/asciidoc/60-documentation.adoc b/src/docs/asciidoc/60-documentation.adoc index 6c0bde02..02d71686 100644 --- a/src/docs/asciidoc/60-documentation.adoc +++ b/src/docs/asciidoc/60-documentation.adoc @@ -5,7 +5,7 @@ The application module model created via `ApplicationModules` can be used to cre Spring Modulith's `Documenter` abstraction can produce two different kinds of snippets: * C4 and UML component diagrams describing the relationships between the individual application modules -* A so called __Application Module Canvas__, a tabular overview about the module and the most relevant elements in those (Spring beans, aggregate roots, events published and listened to as well as configuration properties). +* A so-called __Application Module Canvas__, a tabular overview about the module and the most relevant elements in those (Spring beans, aggregate roots, events published and listened to as well as configuration properties). [[documentation.component-diagrams]] == Generating Application Module Component diagrams diff --git a/src/docs/asciidoc/70-observability.adoc b/src/docs/asciidoc/70-observability.adoc index 900e8046..3f88339f 100644 --- a/src/docs/asciidoc/70-observability.adoc +++ b/src/docs/asciidoc/70-observability.adoc @@ -11,7 +11,7 @@ To activate the instrumentation add the following runtime dependency to your pro org.springframework.modulith spring-modulith-observability {projectVersion} - runtimeruntime ----