Skip to content

Commit de70fe3

Browse files
committed
GH-257 - Add appendix listing all configuration properties exposed.
1 parent bb1f020 commit de70fe3

File tree

2 files changed

+51
-11
lines changed

2 files changed

+51
-11
lines changed

src/docs/asciidoc/50-moments.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[[moments]]
22
= Moments -- a Passage of Time Events API
33

4-
`modulith-moments` is a Passage of Time Events implementation heavily inspired by Matthias Verraes https://verraes.net/2019/05/patterns-for-decoupling-distsys-passage-of-time-event/[blog post].
4+
`spring-modulith-moments` is a Passage of Time Events implementation heavily inspired by Matthias Verraes https://verraes.net/2019/05/patterns-for-decoupling-distsys-passage-of-time-event/[blog post].
55
It's an event-based approach to time to trigger actions that are tied to a particular period of time having passed.
66

77
To use the abstraction, include the following dependency in your project:

src/docs/asciidoc/90-appendix.adoc

+50-10
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,44 @@
33
:jdbc-schema-base: ../../../spring-modulith-events/spring-modulith-events-jdbc/src/main/resources
44

55
[appendix]
6-
[[appendix.migrating-from-moduliths]]
7-
== Migrating from Moduliths
6+
[[appendix.configuration-properties]]
7+
== Spring Modulith Configuration Properties
8+
[cols="2,1,3", options="header, unbreakable"]
9+
|===
10+
|Property|Default value|Description
811

12+
|`spring.modulith.default-async-termination`
13+
|`true`
14+
|Whether to configure defaults for the async processing termination, namely to wait for task completion for 2 seconds. See `TaskExecutionProperties` for details.
915

10-
* `o.m.model.Modules` has been renamed to `o.s.m.model.ApplicationModules`
11-
* `o.m.model.ModuleDetectionStrategy` has been renamed to `o.s.m.model.ApplicationModuleDetectionStrategy`
16+
|`spring.modulith.events.jdbc.schema-initialization.enabled`
17+
|`false`
18+
|Whether to initialize the JDBC event publication schema.
1219

13-
* `@o.m.test.ModuleTest` has been renamed to `@o.s.m.test.ApplicationModuleTest`
20+
|`spring.modulith.events.mongodb.transaction-management.enabled`
21+
|`true`
22+
|Whether to automatically enable transactions for MongoDB. Requires the database to be run with a replica set.
1423

15-
* `o.m.docs.Documenter.Options` has been renamed to `o.s.m.docs.Documenter.DiagramOptions`
16-
* The diagram style of component diagrams now defaults to `DiagramStyle.C4` (override by calling `DiagramOptions.withStyle(DiagramStyle.UML)`)
17-
* The module canvas hides non exposed types by default.
18-
To include application-module-internal types in the canvas, configure `CanvasOptions` to `….revealInternals()`.
19-
* The output folder for component diagrams and application module canvases has moved from `moduliths-docs` to `spring-modulith-docs` located in your build's target folder (such as `target` for Maven).
24+
|`spring.modulith.moments.enableTimeMachine`
25+
|`false`
26+
|Whether to enable the <<moments, `TimeMachine`>>.
27+
28+
|`spring.modulith.moments.granularity`
29+
|`HOURS`
30+
|The granularity of events to publish. (`HOURS`, `DAYS`)
31+
32+
|`spring.modulith.moments.locale`
33+
|`Locale.getDefault()`
34+
|The `Locale` to use when determining week boundaries.
35+
36+
|`spring.modulith.moments.zoneId`
37+
|`ZoneOffset.UTC`
38+
|The timezone of the dates for the events being published.
39+
40+
|`spring.modulith.republish-outstanding-events-on-restart`
41+
|`false`
42+
|Whether to republish outstanding event publications on restarts of the application.
43+
|===
2044

2145
[appendix]
2246
[[appendix.artifacts]]
@@ -120,3 +144,19 @@ include::{jdbc-schema-base}/schema-mysql.sql[]
120144
----
121145
include::{jdbc-schema-base}/schema-postgresql.sql[]
122146
----
147+
148+
[appendix]
149+
[[appendix.migrating-from-moduliths]]
150+
== Migrating from Moduliths
151+
152+
153+
* `o.m.model.Modules` has been renamed to `o.s.m.model.ApplicationModules`
154+
* `o.m.model.ModuleDetectionStrategy` has been renamed to `o.s.m.model.ApplicationModuleDetectionStrategy`
155+
156+
* `@o.m.test.ModuleTest` has been renamed to `@o.s.m.test.ApplicationModuleTest`
157+
158+
* `o.m.docs.Documenter.Options` has been renamed to `o.s.m.docs.Documenter.DiagramOptions`
159+
* The diagram style of component diagrams now defaults to `DiagramStyle.C4` (override by calling `DiagramOptions.withStyle(DiagramStyle.UML)`)
160+
* The module canvas hides non exposed types by default.
161+
To include application-module-internal types in the canvas, configure `CanvasOptions` to `….revealInternals()`.
162+
* The output folder for component diagrams and application module canvases has moved from `moduliths-docs` to `spring-modulith-docs` located in your build's target folder (such as `target` for Maven).

0 commit comments

Comments
 (0)