Add comprehensive README.md for AEM plugin sample with deployment and configuration guide #2387
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Created a comprehensive README.md file for the AEM plugin sample (
turing-aem/aem-plugin-sample/
) that was missing documentation. This addresses the need for clear guidance on what the sample demonstrates and how to deploy and configure it.What's Added
The new README.md provides complete documentation covering:
Sample Overview: Explains that this is a working example of the Turing AEM Connector Plugin, demonstrating custom extensions for Adobe Experience Manager content indexing and search integration with Viglet Turing.
Core Components Documentation:
TurAemExtSampleDeltaDate
,TurAemExtSampleModelJson
)Deployment Instructions: Two deployment options provided:
compile-and-run.cmd
Configuration Guide: Detailed configuration instructions including:
TURING_URL
,TURING_API_KEY
)Usage and Troubleshooting: Practical guidance for:
Technical Details
The documentation accurately reflects the existing project structure:
wknd.json
This makes the AEM plugin sample much more accessible to developers who want to understand, deploy, and extend AEM-to-Turing integration capabilities.
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
jitpack.io
/usr/lib/jvm/temurin-17-jdk-amd64/bin/java -classpath /home/REDACTED/work/turing/turing/.mvn/wrapper/maven-wrapper.jar -Dmaven.multiModuleProjectDirectory=/home/REDACTED/work/turing/turing org.apache.maven.wrapper.MavenWrapperMain clean compile -q
(dns block)If you need me to access, download, or install something from one of these locations, you can either:
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.