From 080195af1994992d882c889160fca5c7567bf50b Mon Sep 17 00:00:00 2001 From: Oliver Drotbohm Date: Fri, 21 Oct 2022 10:41:21 +0200 Subject: [PATCH] GH-6 - More migration instructions in reference documentation. --- src/docs/asciidoc/90-appendix.adoc | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/src/docs/asciidoc/90-appendix.adoc b/src/docs/asciidoc/90-appendix.adoc index ac9da66f..7c8727b9 100644 --- a/src/docs/asciidoc/90-appendix.adoc +++ b/src/docs/asciidoc/90-appendix.adoc @@ -6,8 +6,17 @@ [[appendix.migrating-from-moduliths]] == Migrating from Moduliths -* `Modules` -> `ApplicationModules` -* `@ModuleTest`-> `ApplicationModuleTest` + +* `o.m.model.Modules` has been renamed to `o.s.m.model.ApplicationModules` +* `o.m.model.ModuleDetectionStrategy` has been renamed to `o.s.m.model.ApplicationModuleDetectionStrategy` + +* `@o.m.test.ModuleTest` has been renamed to `@o.s.m.test.ApplicationModuleTest` + +* `o.m.docs.Documenter.Options` has been renamed to `o.s.m.docs.Documenter.DiagramOptions` +* The diagram style of component diagrams now defaults to `DiagramStyle.C4` (override by calling `DiagramOptions.withStyle(DiagramStyle.UML)`) +* The module canvas hides non exposed types by default. +To include application-module-internal types in the canvas, configure `CanvasOptions` to `….revealInternals()`. +* 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). [appendix] [[appendix.artifacts]]