Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Sep 19, 2025

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:

  • Custom extension implementations (TurAemExtSampleDeltaDate, TurAemExtSampleModelJson)
  • Pre-configured WKND sample site setup
  • Automated build and deployment scripts

Deployment Instructions: Two deployment options provided:

  1. Quick Start: Automated build and run using compile-and-run.cmd
  2. Manual Process: Step-by-step Maven and Ant build instructions with file copying

Configuration Guide: Detailed configuration instructions including:

  • Environment variables setup (TURING_URL, TURING_API_KEY)
  • AEM source configuration with JSON examples
  • Parameter reference table for key settings
  • Custom extension development guidance

Usage and Troubleshooting: Practical guidance for:

  • Starting and monitoring the connector
  • Common issues and debugging approaches
  • Links to support resources and next steps

Technical Details

The documentation accurately reflects the existing project structure:

  • References verified file paths and scripts
  • Includes actual configuration examples from wknd.json
  • Covers both Windows batch scripts and cross-platform Maven commands
  • Maintains consistency with the existing codebase architecture

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
    • Triggering command: /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.

Co-authored-by: alegauss <331174+alegauss@users.noreply.github.com>
@alegauss alegauss marked this pull request as ready for review September 19, 2025 21:28
@Copilot Copilot AI changed the title [WIP] create a README.md to @openviglet/turing/files/turing-aem/aem-plugin-sample, that explain what this sample, and how deploy and configure Add comprehensive README.md for AEM plugin sample with deployment and configuration guide Sep 19, 2025
@Copilot Copilot AI requested a review from alegauss September 19, 2025 21:29
Copilot finished work on behalf of alegauss September 19, 2025 21:29
@alegauss alegauss merged commit 8007ac9 into 2025.3 Sep 19, 2025
6 checks passed
@sonarqubecloud
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants