Getting Started Guide
This guide provides role-based reading paths through the MATIH Platform documentation. Based on your role and goals, follow the recommended path to build your understanding efficiently. Each path is ordered to build knowledge progressively.
Choose Your Path
| If You Are | Start Here | Then Read | Goal |
|---|---|---|---|
| Evaluating the platform | Vision and Mission | Problem Space, Capabilities | Understand the value proposition |
| Data Engineer | Technology Stack | Architecture, Data Stores, Pipelines | Plan integration |
| BI Developer | Capabilities (BI) | AI Service, BI Service, Dashboards | Build dashboards |
| ML Engineer | ML Infrastructure | ML Service, Ray, MLflow | Train and deploy models |
| Platform Administrator | Architecture Overview | Kubernetes, Helm, Observability | Deploy and operate |
| Security Reviewer | Tenant Isolation | JWT Tokens, RBAC, Network Policies | Audit security posture |
| Frontend Developer | Frontend Stack | Workbench UI, API Client | Build UI features |
Path 1: Platform Evaluator
If you are assessing whether MATIH fits your organization's needs, follow this reading order:
- Vision and Mission -- Understand the founding principles
- Problem Space -- See the problems MATIH solves
- Platform Capabilities -- Review the six capability pillars
- User Personas -- Match your team to platform personas
- Architecture Preview -- High-level system structure
- Design Decisions -- Understand trade-offs
Estimated reading time: 2-3 hours
Path 2: Backend Developer
If you are building or maintaining backend services:
- Technology Stack: Backend -- Languages and frameworks
- Architecture Deep Dive -- Full system architecture
- Control Plane or Data Plane -- Your service area
- API Design -- REST conventions and error handling
- Multi-Tenancy Architecture -- Tenant context propagation
- Event-Driven Architecture -- Kafka and event patterns
- Security -- Authentication, authorization, and isolation
Estimated reading time: 4-6 hours
Path 3: Data Engineer
If you are integrating data pipelines or connecting data sources:
- Technology Stack: Data Infrastructure -- Data technologies
- Data Stores -- PostgreSQL, Kafka, Trino, and more
- Data Flow -- Request lifecycle and query flow
- Pipeline Flow -- Pipeline orchestration
- Compute Engines -- Trino, Spark, Flink
Estimated reading time: 3-4 hours
Path 4: ML Engineer
If you are training models or deploying ML workflows:
- Technology Stack: ML Infrastructure -- ML/AI technologies
- ML Flow -- Model training and serving lifecycle
- Compute Engines -- Ray, Spark
- Data Stores: Vector Stores -- Qdrant, LanceDB
Estimated reading time: 2-3 hours
Path 5: Platform Administrator
If you are deploying, configuring, or operating the platform:
- Architecture Preview -- System structure
- Service Topology -- Service dependencies and failure domains
- Multi-Tenancy -- Namespace and resource isolation
- Technology Stack: Orchestration -- Kubernetes, Helm, Terraform
- Security -- Full security model
Estimated reading time: 4-5 hours
Path 6: Security Reviewer
If you are auditing the platform's security posture:
- Security Overview -- Full security model
- Tenant Isolation -- Multi-layer isolation
- JWT Tokens -- Token structure and lifecycle
- RBAC -- Role hierarchy and permissions
- Multi-Tenancy: Database Isolation -- Data isolation
- Multi-Tenancy: Namespace Isolation -- Infrastructure isolation
- Encryption -- Data at rest and in transit
Estimated reading time: 3-4 hours
Quick Reference
Key Terminology
Before diving deep, familiarize yourself with the Key Terminology page. It defines 100+ terms organized by domain, covering the Control Plane, Data Plane, AI agents, multi-tenancy, and infrastructure concepts.
Documentation Conventions
| Convention | Meaning |
|---|---|
monospace text | Code, commands, file paths, service names |
| Bold text | Terms being defined or important notes |
| Tables with "Planned" markers | Features designed but not yet implemented |
| Port numbers in parentheses | Default service port, e.g., ai-service (8000) |
Getting Help
| Resource | Description |
|---|---|
| Architecture Overview | Complete system architecture reference |
| Service Topology | Service dependency and failure analysis |
| Key Terminology | Glossary of platform terms |
Next Steps
Choose the path that matches your role and begin reading. Each chapter builds on the concepts introduced in this introductory chapter. If you have not yet read the Vision and Mission section, it provides essential context for understanding the design decisions throughout the platform.