How westofengland-ca/weca_tdh_ckan works
Main Components
a. Core Components:
• CKAN Core Platform (central component)
• WECA TDH Extension (ckanext-weca-tdh)
• CLI Tools Layer (ckan-cli)
• Web Interface Layer
• Database Layer (PostgreSQL)
• NGINX Web Server
b. Extension Components:
• Authentication System
• Template Engine
• Asset Management
• Plugin System
• API Layer
Component Relationships
• NGINX as the front-facing component, handling HTTP requests
• CKAN Core as the central component
• WECA TDH Extension connecting to CKAN Core
• CLI Tools interfacing with the API Layer
Specific Implementation Details
• Blue containers for Docker components
• Green components for the custom WECA extension
• Yellow for external interfaces (API, CLI)
• Gray for infrastructure components (NGINX, PostgreSQL)
Key Architectural Elements
Distinct layers:
[Web Layer (NGINX)]
• ↓
[Template Layer (Jinja2 Templates)]
• ↓
[CKAN Core + WECA Extension]
• ↓
[Database Layer (PostgreSQL)]
Integration Points
Highlight:
• API endpoints for CLI tool integration
• Template override system
• Asset pipeline
• Authentication flow
• Plugin hook points
Development/Deployment Flow
A separate section showing:
• Docker container relationships
• CI/CD pipeline flow
• Development environment setup
Specific Details
• Custom templates location
• Asset management system
• Configuration management
• Authentication handlers
• Custom controllers and helpers
Technical Specifications
Aspects:
• Docker-based deployment
• CKAN extension architecture
• Template inheritance system
• Asset compilation pipeline
• Database schema extensions
[Frontend Layer]
• NGINX (reverse proxy)
• Template System
• Asset Pipeline
[Application Layer]
• CKAN Core
• WECA Extension
• Authentication
• Controllers
[Data Layer]
• PostgreSQL
• Data Storage
• Search Index
[Integration Layer]
• CLI Tools
• API Endpoints
• External Services
Remember to:
• Keep components modular and clearly separated
• Version information
• Configuration dependencies