How yalesites-org/yalesites-project works
This project is a full‐stack platform built to serve as a custom Drupal upstream on Pantheon – essentially a tailored digital experience framework for the Yale community. It is designed as both the codebase and the configuration repository that supports local development, automated code quality and testing processes, and continuous integration and delivery to production on Pantheon.
And Label Key Components
• Local Development Environment:
• Local developer “sandbox” that uses tools such as Lando (with example .lando files), npm build scripts (as seen in package.json and scripts/local/), and Composer for PHP dependencies.
• Blocks for the various npm scripts (build, build-with-assets, build-with-install, confex/confim, local:theme-link, etc.) which streamline local site builds and configuration synchronization.
• Continuous Integration / Delivery (CI/CD) Pipeline:
• Pantheon and Deployment Infrastructure:
• Components for Pantheon configurations (pantheon.yml, pantheon.upstream.yml, and specific deployment subdirectories under .ci/deploy for Pantheon) that drive how the built site is deployed to the Pantheon environment.
• Drupal Code, Configuration, and Custom Modules/Themes:
• “web” directory as the heart of the Drupal installation, including custom sites, profiles (especially “yalesites_profile” which underpins the platform’s custom modules, themes, and configurations), and contributed modules.
• External Dependencies and Configuration Files:
• General configuration files (composer.json, package.json, etc.) as an “External Libraries & Dependencies” block.
• Documentation and configuration directories (docs, config, patches) that support the overall maintenance and integration of the platform.
Relationships and Interactions
• Code Flow:
• CI/CD Process:
• That commits trigger GitHub workflows that run tests, export/import configurations (confex/confim), and run build scripts.
• From the CI pipelines, illustrate the process to package and deliver builds to the deployment system.
• Deployment Pipeline:
• That once the CI/CD checks pass, the built code and configuration are then deployed to Pantheon via automated scripts (e.g., those under .ci/deploy and GitHub deployment workflows).
• Separation of Concerns:
• Separation between frontend (theme development and asset building) and backend (Drupal, custom modules, configuration management) which are supported by dedicated scripts and configuration management practices.
Architectural Patterns and Design Principles
• Modular Architecture:
• Significance of modularity – Drupal itself is modular, and the project leverages this by having separate custom modules and themes. Visually separate these modules and clearly label which areas are customizations for YaleSites.
• Automation and Continuous Delivery:
• Deep integration of CI/CD, with automated testing, code quality checks, and build processes. Represent these as a distinct pipeline driving both the build-time and deployment-time activities.
• Environment Parity:
• Versioning and Configuration Management:
Putting It All Together
• Finally, connect the finalized build to a “Deployment” block that represents Pantheon (including the upstream configuration) and ultimately to the running “Drupal Application” environment, where Drupal code, custom modules and themes are executed.
• Optionally, include a side section that summarizes external dependencies (like Composer and npm packages) feeding into the Drupal code base.