Event and Membership Management Documentation
This guide provides information about the requirements, design and operation of the procedures, processes, equipment, tools and software systems used for event and membership management.
|
New here, or unsure where a document belongs? Start with How This Documentation Is Structured — it explains what each module is for and the two axes (audience and nature) that separate operations, runbooks, procedures, and user guides. |
Documentation Modules
| Common Design |
Cross-cutting requirements and designs shared across applications |
| Domain Entities |
JPA entity definitions for event and membership domains |
| Components |
System components, architecture, and dependencies |
| Deployment |
Build, deployment, and infrastructure documentation |
| Operations |
System-health operations — management API, cache, observability, SMTP |
| Operational Procedures |
Repeatable recipes that produce a standard business outcome — imports, number/tag lifecycle, reporting |
| Runbooks |
Exceptional one-off recovery and data-correction procedures |
| User Guide |
Guidelines, help guides, and training material for staff learning the system |
| Development |
Local development setup and build automation |
| Security |
Authentication, authorization, and security architecture |
Application Design
| Admin Portal Design |
Administration interface design |
| Membership Portal Design |
Membership self-service portal |
| Race App Design |
Mobile race day application |
Getting Started
For developers new to the project:
-
Set up local development: See Running Backend Services Locally
-
Understand the architecture: See Components
-
Deploy to Kubernetes: See ArgoCD Deployment