From 63019d7176cd1fe81607254bf5d1a8ba9bc7458e Mon Sep 17 00:00:00 2001 From: Grzegorz Kozub Date: Wed, 5 Jan 2022 18:30:49 +0100 Subject: [PATCH 1/2] chore(docs): Add FAQs section to docs with information about Lombok support. --- docs/FAQs.md | 27 +++++++++++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 28 insertions(+) create mode 100644 docs/FAQs.md diff --git a/docs/FAQs.md b/docs/FAQs.md new file mode 100644 index 000000000..4c2be3460 --- /dev/null +++ b/docs/FAQs.md @@ -0,0 +1,27 @@ +--- +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="5" + + + + ${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 From 8705e2d2f63c209d382f95ffcb6b87350ff9e1d2 Mon Sep 17 00:00:00 2001 From: Grzegorz Kozub Date: Thu, 6 Jan 2022 17:26:21 +0100 Subject: [PATCH 2/2] chore(docs): Fix highlighting of code snipped in FAQ --- docs/FAQs.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/FAQs.md b/docs/FAQs.md index 4c2be3460..582590740 100644 --- a/docs/FAQs.md +++ b/docs/FAQs.md @@ -10,8 +10,9 @@ Poweretools uses `aspectj-maven-plugin` to compile-time weave (CTW) aspects into To enable in-place weaving feature you need to use following `aspectj-maven-plugin` configuration: -```xml hl_lines="5" +```xml hl_lines="2-6" + true ${project.build.directory}/classes