How techdivision/eds-multisite-demo-brand-red works
Main Components
• Main Repository: The central codebase (this repository) which contains the shared site code, GitHub workflow configurations, and common assets (e.g., blocks, global styles, scripts).
• Child Repositories: These are the per-brand repositories (evidenced by links to eds-multisite-demo-brand-red and eds-multisite-demo-brand-blue) that receive synced content from the main repository.
• Multi-Site Configuration: The “.multisite” folder holds the configuration file (config.yaml) and brand-specific directories (brand-blue & brand-red) including overrides (e.g., custom theme.css files) and fstab settings.
• GitHub Actions/Workflows: The .github folder, including workflows like sync.yaml, drives automated synchronization between the main repository and child repositories.
• Shared Components and Assets: The “blocks” directory (with header, hero, footer, cards, etc.), global styles, scripts, and fonts represent the building blocks for the various web pages served by AEM.
• AEM Edge Delivery Services: Although not present as source files, the deployment endpoints and integration with AEM are central to the project, handling the delivery to different environments for each brand.
Relationships and Interactions
• The Main Repository serves as the primary code repository where all shared features and implementations reside.
• GitHub Actions (configured via workflows such as sync.yaml) authenticate with the GitHub App to initiate sync jobs that update child repositories.
• The .multisite folder and its subdirectories allow for both shared configurations (in config.yaml) and brand-specific customizations (via override files per brand).
• After code is synchronized and merged into brand-specific repositories, each deployment pipeline pushes the content to the corresponding AEM Edge Delivery Service environment endpoints.
• The shared blocks and assets are used to construct the pages and can be overridden in specific brand directories to meet brand-specific styling or functionality.
Important Architectural Patterns and Design Principles
• Shared Codebase with Override Pattern: Emphasize the structured approach where a unified repository manages all major content while brand-specific customizations are handled via an override mechanism in the .multisite folder.
• CI/CD Automation: Highlight the GitHub Actions workflows that automate repository sync and deployment processes.
• Modular Component Design: The “blocks” directory represents a modular approach to building page elements. Emphasize reusability and clear separation of concerns.
• Multi-Tenancy: Different environments (brand-specific endpoints) are achieved by abstracting common functionalities and allowing configurations per brand.
Final Touches
• Maintain clear and intuitive labels for ease of understanding by both developers and architects.