How adobe/aem-guides-wknd works
Project Type and Purpose
• This is a full-stack Adobe Experience Manager (AEM) Sites reference implementation (“WKND”) built with a multi-module Maven structure. It includes OSGi services, content packages, front-end assets, configuration modules, sample content, testing suites, and a Dispatcher cache layer.
Main Architectural Components
a. CI/CD Pipeline
• GitHub Actions & Cloud Manager (build & release workflows)
• Maven goals: compile OSGi bundles, assemble content packages, run integration tests, publish to Cloud Manager.
b. Maven Modules (build artifacts)
• “core” – Java OSGi bundles (models, services).
• “ui.apps” – content definitions & HTL scripts under /apps/wknd.
• “ui.config” – OSGi config for author & publish run modes.
• “ui.content.sample” – sample site content (pages, assets).
• “ui.content” – production content filters & WCM policies.
• “ui.frontend” – Webpack/Sass/TypeScript clientlibs for styling & interactivity.
• “dispatcher” – Apache HTTP Dispatcher config for caching & request routing.
• “it.tests” – Java integration tests using AEM Test Framework.
• “ui.tests” – end-to-end tests with Cypress.
c. AEM Environments
• Author instance – content authors.
• Publish instance – delivery of published content.
• Dispatcher – caching & web-server front.
d. End Users & External Services
• Site visitors – HTTP/HTTPS requests.
• Adobe Stock (third-party assets).
Component Relationships & Data Flow (vertical orientation)
[Top] 1. Developer commits → triggers GitHub Actions/Cloud Manager
↓
2. Maven multi-module build
• compiles “core” → OSGi bundles
• packages “ui.*” → content JARs
• bundles “ui.frontend” → clientlib ZIP
• assembles “dispatcher”
• runs “it.tests” & “ui.tests”
↓
3. Deployment
• Content packages & OSGi bundles → AEM Author/Publish via Cloud Manager
• Dispatcher config → CDN/Dispatcher servers
↓
4. Runtime
• Dispatcher serves static assets & caches HTML
• Dynamic requests routed to AEM Publish (templates, Sling/HTL, Java models)
• AEM invokes “core” services/models to fetch JCR content
• “ui.frontend” clientlibs downloaded by browser
↓
5. End Users interact with site
Architectural Patterns & Principles
• Modular Maven structure (separation of services, content, config, front-end, tests)
• OSGi microkernel: “core” bundles on Sling
• Content-package driven delivery: “ui.apps”, “ui.content”
• Clientlibs for CSS/JS bundling (Webpack)
• Dispatcher caching & cache-invalidations rules
• Multi-stage CI/CD: build → test → deploy
Technologies & Frameworks
• Java/Osgi/Sling/HTL (AEM Core Components)
• Maven (3.x), GitHub Actions, Cloud Manager
• Webpack, Sass, TypeScript (ui.frontend)
• Apache HTTP Dispatcher
• JUnit (it.tests), Cypress (ui.tests)
• CRX/Jackrabbit Oak (JCR repository)
Final Recommendations
• Expand each stage with sub-components (e.g., list Maven modules under Build).