This is an automated email from the ASF dual-hosted git repository. arnold pushed a commit to branch develop in repository https://gitbox.apache.org/repos/asf/fineract.git
commit 119ac6d592e0ac8760ba9181945537423acf0345 Author: Arnold Galovics <[email protected]> AuthorDate: Fri Jun 2 18:50:39 2023 +0200 FINERACT-1724: Documentation fix not to refer spring.factories anymore --- fineract-doc/src/docs/en/chapters/custom/intro.adoc | 4 ++-- .../src/docs/en/diagrams/custom-db-migration-folder-structure.puml | 2 +- fineract-doc/src/docs/en/diagrams/custom-folder-structure.puml | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/fineract-doc/src/docs/en/chapters/custom/intro.adoc b/fineract-doc/src/docs/en/chapters/custom/intro.adoc index 7be11de7f..54ea099a2 100644 --- a/fineract-doc/src/docs/en/chapters/custom/intro.adoc +++ b/fineract-doc/src/docs/en/chapters/custom/intro.adoc @@ -20,11 +20,11 @@ As soon as we can publish Fineract module JARs to Maven Central you'll have more 1. Create a folder under `custom` and name it according to your company/organisation (e. g. `acme` if your company is `ACME Inc.`); this way your custom modules can't clash even with other companies' modules 2. Under your company folder create a folder for the `category` or `domain` your module is targeting; e. g. "loan", "client", "account" etc. 3. Finally, setup `library` folders for the actual modules you want to create; usually that will be to replace/extend some existing service, so there could be a `service` folder, maybe even a `core` folder, e. g. if you want to add additional DTOs etc.; we have also an example for COB business steps -4. Per `category`/`domain` you should have a `starter` library; means: a Spring Boot auto-configuration setup that makes including your module in Fineract easier ("hands-free"); the necessary parts for a auto-configuration library are a Spring Java configuration class (annotated with `@Configuration`) and a text file at `META-INF/spring.factories` in your starter resource folder: +4. Per `category`/`domain` you should have a `starter` library; means: a Spring Boot auto-configuration setup that makes including your module in Fineract easier ("hands-free"); the necessary parts for a auto-configuration library are a Spring Java configuration class (annotated with `@Configuration`) and a text file at `META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports` in your starter resource folder: + [source,properties] ---- -include::{rootdir}/custom/acme/note/starter/src/main/resources/META-INF/spring.factories[] +include::{rootdir}/custom/acme/note/starter/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports[] ---- + Please make sure that your module libraries have proper `build.gradle` files: diff --git a/fineract-doc/src/docs/en/diagrams/custom-db-migration-folder-structure.puml b/fineract-doc/src/docs/en/diagrams/custom-db-migration-folder-structure.puml index 17b2c8cf6..2f431ffc1 100644 --- a/fineract-doc/src/docs/en/diagrams/custom-db-migration-folder-structure.puml +++ b/fineract-doc/src/docs/en/diagrams/custom-db-migration-folder-structure.puml @@ -17,7 +17,7 @@ +++++++++ 0001_acme_note_initial.xml ++++++++ changelog-acme-note.xml ++++++ META-INF - +++++++ spring.factories + +++++++ spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports +++++ build.gradle +++++ dependencies.gradle } diff --git a/fineract-doc/src/docs/en/diagrams/custom-folder-structure.puml b/fineract-doc/src/docs/en/diagrams/custom-folder-structure.puml index b0a73ae2a..63044cad9 100644 --- a/fineract-doc/src/docs/en/diagrams/custom-folder-structure.puml +++ b/fineract-doc/src/docs/en/diagrams/custom-folder-structure.puml @@ -32,7 +32,7 @@ +++++++++ AcmeNoteAutoConfiguration.java +++++ resources ++++++ META-INF - +++++++ spring.factories + +++++++ spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports +++++ build.gradle +++++ dependencies.gradle }
