feat: add comprehensive replication skills for AEM 6…#48
Open
abhishekgarg18 wants to merge 5 commits intoadobe:betafrom
Open
feat: add comprehensive replication skills for AEM 6…#48abhishekgarg18 wants to merge 5 commits intoadobe:betafrom
abhishekgarg18 wants to merge 5 commits intoadobe:betafrom
Conversation
….5 LTS Add four specialist replication skills under skills/aem/6.5-lts/skills/aem-replication: - configure-replication-agent: Configure replication agents for publishing, dispatcher flush, and reverse replication - replicate-content: Activate/deactivate content using UI, workflows, and package manager - replication-api: Use Replication API programmatically with 49 Java code examples - troubleshoot-replication: Diagnose and fix 12+ common replication issues Key features: - 3,575 lines of comprehensive documentation - All based on official Adobe AEM 6.5 LTS documentation - Complete coverage of 8 public Replication APIs (Replicator, ReplicationOptions, AgentManager, ReplicationQueue, etc.) - Router pattern following dispatcher skill structure - Integrated into aem-6-5-lts plugin Documentation sources: - Official AEM 6.5 LTS Replication Guide - Official AEM 6.5 LTS Troubleshooting Guide - Official AEM 6.5 LTS JavaDoc API Reference Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Critical fixes: - Replace hardcoded admin:admin credentials with environment variables in CURL examples - Add security note about using proper service account credentials Important fixes: - Add null checks after resolver.adaptTo(Session.class) calls to prevent NullPointerException - Add compatibility metadata to router SKILL.md (AEM 6.5 LTS/AMS only, not Cloud Service) - Add Cloud Service migration guidance section referencing Sling Distribution API - Add input validation to servlet example (path validation and session null check) - Update Maven dependencies from 6.5.0 to 6.5.21 with comment to use latest version These changes address all critical and important issues identified in the PR review, improving security practices, code safety, and forward-looking guidance for AEM customers. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
…ions - Remove specific version numbers (6.5.0, 6.5.21) from Maven dependencies - Remove potentially incorrect individual cq-replication artifact - Keep only uber-jar dependency without version specification - Add explanation that version should match AEM 6.5 LTS installation - Maintain focus on '6.5 LTS' as the designation, not point releases Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
abhishekgarg18
force-pushed
the
feature/aem-replication-skills-6.5-lts
branch
from
2e10f55 to
7351e78
Compare
…entation This commit addresses all important review findings except MCP tool contract: ## New Architecture Components **References Foundation (references/replication-foundation/):** - agent-types.md: Documentation for Default, Dispatcher Flush, Reverse, Static agents - queue-mechanics.md: FIFO processing, retry logic, blocking behavior, queue management - 65-lts-guardrails.md: Service users, timeouts, batch limits, security best practices - api-reference.md: Quick reference for Replicator, ReplicationOptions, ReplicationStatus **Replication Orchestrator (replication-orchestrator/SKILL.md):** - New sub-skill for end-to-end workflows spanning multiple concerns - Workflow 1: New environment setup (configure → test → troubleshoot) - Workflow 2: Production incident response (diagnose → fix → verify) - Workflow 3: Performance optimization (measure → tune → validate) - Workflow 4: Migration preparation (audit → plan → execute) ## Documentation Enhancements **Router SKILL.md:** - Added orchestrator to Intent Router table - Added Replication Orchestrator to Skill Overview - Added Foundation References section with links to shared references **replication-api/SKILL.md:** - Fixed service user mapping configuration (invalid XML → correct OSGi config) - Added comprehensive "ResourceResolver Lifecycle Management" section - Caller responsibility pattern with JavaDoc examples - Try-with-resources pattern (recommended) - Manual close pattern (legacy) - Resource leak prevention examples - Added "Error Handling Patterns" section - Pattern 1: Throw exceptions (library code) - Pattern 2: Return boolean (service layer) - Pattern 3: HTTP status codes (servlets/REST) - Comparison table and anti-patterns - Enhanced input validation with resource type checking - Added isReplicableResource() helper method - Validates cq:Page, dam:Asset, experience fragments - Prevents replication of system/config resources **replicate-content/SKILL.md:** - Enhanced CURL examples with HTTP status code checking - Added error handling versions with response validation - Added simple versions for quick testing (with warnings) - All examples use environment variables for credentials ## Alignment with Established Patterns This refactor brings the replication skill set into alignment with dispatcher and aem-workflow patterns: - Shared foundation references (like dispatcher-foundation/) - Orchestrator sub-skill for multi-step workflows - Separation of reference content from workflow guidance ## Files Changed Modified: - skills/aem/6.5-lts/skills/aem-replication/SKILL.md - skills/aem/6.5-lts/skills/aem-replication/replicate-content/SKILL.md - skills/aem/6.5-lts/skills/aem-replication/replication-api/SKILL.md New directories: - skills/aem/6.5-lts/skills/aem-replication/references/replication-foundation/ - skills/aem/6.5-lts/skills/aem-replication/replication-orchestrator/ New files: - references/replication-foundation/agent-types.md - references/replication-foundation/queue-mechanics.md - references/replication-foundation/65-lts-guardrails.md - references/replication-foundation/api-reference.md - replication-orchestrator/SKILL.md Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Address all minor review findings to improve documentation completeness: Code Examples (replication-api/SKILL.md): - Add missing import statements to all Java examples for copy-paste readiness - Add comprehensive Javadoc to isReplicableResource() method - Add defensive null/empty check to bulk activation example - Document thread-blocking implications of synchronous replication CURL Examples (replicate-content/SKILL.md): - Enhance examples with jq-based JSON response validation - Validate success status in response body, not just HTTP codes Error Handling (api-reference.md): - Add retry with exponential backoff pattern - Add fallback to async on timeout pattern - Add circuit breaker pattern for cascade failure prevention Agent Configuration (agent-types.md): - Add null safety checks for programmatic agent access - Document agent ordering implications (parallel processing) Queue Monitoring (queue-mechanics.md): - Add JMX security considerations and access control guidance - Add queue listener pattern for event-driven monitoring Guardrails (65-lts-guardrails.md): - Add version-specific API deprecation tracking guidance - Link to official release notes for service pack compatibility Cloud Migration (replication-orchestrator/SKILL.md): - Fix reference to non-existent cloud service docs - Link to official Adobe Cloud Service documentation instead Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Collaborator
Author
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Add AEM 6.5 LTS Replication Skills
Adds comprehensive replication skills for AEM 6.5 LTS customers, integrated into the existing
aem-6-5-ltsplugin.Architecture
Follows the established pattern from
dispatcherandaem-workflowskills:Key Design Decisions:
Complete Feature Set
Sub-Skills
Foundation References
Code Quality & Security
Java Code Examples (49 total)
Security Best Practices
Error Handling & Resilience
Operational Readiness
Migration & Forward-Looking Design
Documentation Sources
All content 100% based on official Adobe AEM 6.5 LTS documentation:
Changes
New Files (13 total):
skills/aem/6.5-lts/skills/aem-replication/README.mdskills/aem/6.5-lts/skills/aem-replication/SKILL.mdskills/aem/6.5-lts/skills/aem-replication/configure-replication-agent/SKILL.mdskills/aem/6.5-lts/skills/aem-replication/replicate-content/SKILL.mdskills/aem/6.5-lts/skills/aem-replication/replication-api/SKILL.mdskills/aem/6.5-lts/skills/aem-replication/troubleshoot-replication/SKILL.mdskills/aem/6.5-lts/skills/aem-replication/replication-orchestrator/SKILL.mdskills/aem/6.5-lts/skills/aem-replication/references/replication-foundation/agent-types.mdskills/aem/6.5-lts/skills/aem-replication/references/replication-foundation/queue-mechanics.mdskills/aem/6.5-lts/skills/aem-replication/references/replication-foundation/65-lts-guardrails.mdskills/aem/6.5-lts/skills/aem-replication/references/replication-foundation/api-reference.mdUpdated Files (2 total):
README.md- Added AEM Replication section with sub-skill table and feature listskills/aem/6.5-lts/.claude-plugin/plugin.json- Updated description and added "replication" keywordStats
Commit History