diff --git a/docs/FAQs.md b/docs/FAQs.md new file mode 100644 index 000000000..582590740 --- /dev/null +++ b/docs/FAQs.md @@ -0,0 +1,28 @@ +--- +title: FAQs +description: Frequently Asked Questions +--- + + +## How can I use Powertools with Lombok? + +Poweretools uses `aspectj-maven-plugin` to compile-time weave (CTW) aspects into the project. In case you want to use `Lombok` or other compile-time preprocessor for your project, it is required to change `aspectj-maven-plugin` configuration to enable in-place weaving feature. Otherwise the plugin will ignore changes introduced by `Lombok` and will use `.java` files as a source. + +To enable in-place weaving feature you need to use following `aspectj-maven-plugin` configuration: + +```xml hl_lines="2-6" + + true + + + ${project.build.directory}/classes + + ... + + + software.amazon.lambda + powertools-logging + + + +``` \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 4218f2c1f..c99bf7d47 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,6 +4,7 @@ site_author: Amazon Web Services nav: - Homepage: index.md - Changelog: changelog.md + - FAQs: FAQs.md - Core utilities: - core/logging.md - core/tracing.md