feat: reword phase to epic, update mkdocs
This commit is contained in:
@@ -26,7 +26,7 @@ Each consolidated story follows this structure:
|
||||
4. **Acceptance Criteria** - How we know it's done
|
||||
5. **Implementation Steps** - High-level steps (not micro-tasks)
|
||||
|
||||
## Phase 0 - Completed Examples
|
||||
## Epic 0 - Completed Examples
|
||||
|
||||
### 0.1 Project Initialization and Repository Structure
|
||||
**Consolidates:** Go module init, directory structure, .gitignore, README
|
||||
@@ -43,17 +43,18 @@ Each consolidated story follows this structure:
|
||||
### 0.5 DI and Application Bootstrap
|
||||
**Consolidates:** Install FX, create DI container, create main.go
|
||||
|
||||
## Remaining Phases - Consolidation Pattern
|
||||
## Remaining Epics - Consolidation Pattern
|
||||
|
||||
### Phase 1: Core Kernel
|
||||
### Epic 1: Core Kernel
|
||||
- **1.1 Enhanced DI Container** - All DI providers and extensions
|
||||
- **1.2 Database Layer** - Complete Ent setup with entities and migrations
|
||||
- **1.3 Health & Metrics** - Complete monitoring system
|
||||
- **1.4 Error Handling** - Complete error bus system
|
||||
- **1.5 HTTP Server** - Complete server with all middleware
|
||||
- **1.6 OpenTelemetry** - Complete tracing setup
|
||||
- **1.7 Service Client Interfaces** - Complete service abstraction layer
|
||||
|
||||
### Phase 2: Authentication & Authorization
|
||||
### Epic 2: Authentication & Authorization
|
||||
- **2.1 JWT Authentication System** - Complete auth with tokens
|
||||
- **2.2 Identity Management** - Complete user lifecycle
|
||||
- **2.3 RBAC System** - Complete permission system
|
||||
@@ -61,25 +62,26 @@ Each consolidated story follows this structure:
|
||||
- **2.5 Audit Logging** - Complete audit system
|
||||
- **2.6 Database Seeding** - Complete seeding system
|
||||
|
||||
### Phase 3: Module Framework
|
||||
### Epic 3: Module Framework
|
||||
- **3.1 Module Interface & Registry** - Complete module system
|
||||
- **3.2 Permission Code Generation** - Complete code gen system
|
||||
- **3.3 Module Loader** - Complete loading and initialization
|
||||
- **3.4 Module CLI** - Complete CLI tool
|
||||
- **3.5 Service Registry** - Complete service discovery
|
||||
|
||||
### Phase 4: Sample Blog Module
|
||||
### Epic 4: Sample Blog Module
|
||||
- **4.1 Complete Blog Module** - Full module with CRUD, permissions, API
|
||||
|
||||
### Phase 5: Infrastructure Adapters
|
||||
### Epic 5: Infrastructure Adapters
|
||||
- **5.1 Cache System** - Complete Redis cache
|
||||
- **5.2 Event Bus** - Complete event system
|
||||
- **5.3 Blob Storage** - Complete S3 storage
|
||||
- **5.4 Email Notification** - Complete email system
|
||||
- **5.5 Scheduler & Jobs** - Complete job system
|
||||
- **5.6 Secret Store** - Complete secret management
|
||||
- **5.7 Multi-tenancy** - Complete tenant support
|
||||
- **5.7 gRPC Services** - Complete gRPC service definitions and clients
|
||||
|
||||
### Phase 6: Observability
|
||||
### Epic 6: Observability
|
||||
- **6.1 Enhanced OpenTelemetry** - Complete tracing
|
||||
- **6.2 Error Reporting** - Complete Sentry integration
|
||||
- **6.3 Enhanced Logging** - Complete log correlation
|
||||
@@ -89,14 +91,14 @@ Each consolidated story follows this structure:
|
||||
- **6.7 Security Hardening** - Complete security
|
||||
- **6.8 Performance Optimization** - Complete optimizations
|
||||
|
||||
### Phase 7: Testing & Documentation
|
||||
### Epic 7: Testing & Documentation
|
||||
- **7.1 Unit Testing** - Complete test suite
|
||||
- **7.2 Integration Testing** - Complete integration tests
|
||||
- **7.3 Documentation** - Complete docs
|
||||
- **7.4 CI/CD Enhancement** - Complete pipeline
|
||||
- **7.5 Docker & Deployment** - Complete deployment setup
|
||||
|
||||
### Phase 8: Advanced Features
|
||||
### Epic 8: Advanced Features
|
||||
- **8.1 OIDC Support** - Complete OIDC
|
||||
- **8.2 GraphQL API** - Complete GraphQL
|
||||
- **8.3 Additional Modules** - Complete sample modules
|
||||
@@ -104,7 +106,7 @@ Each consolidated story follows this structure:
|
||||
|
||||
## Creating New Story Files
|
||||
|
||||
When creating story files for remaining phases, follow this template:
|
||||
When creating story files for remaining epics, follow this template:
|
||||
|
||||
```markdown
|
||||
# Story X.Y: [Meaningful Title]
|
||||
@@ -112,7 +114,7 @@ When creating story files for remaining phases, follow this template:
|
||||
## Metadata
|
||||
- **Story ID**: X.Y
|
||||
- **Title**: [Complete Feature Name]
|
||||
- **Phase**: X - [Phase Name]
|
||||
- **Epic**: X - [Epic Name]
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: [hours]
|
||||
@@ -164,9 +166,9 @@ When creating story files for remaining phases, follow this template:
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. Update remaining phase README files to reference consolidated stories
|
||||
2. Create story files for remaining phases following the pattern
|
||||
3. Update plan.md to complete all phases with story-based structure
|
||||
1. Update remaining epic README files to reference consolidated stories
|
||||
2. Create story files for remaining epics following the pattern
|
||||
3. Update plan.md to complete all epics with story-based structure
|
||||
4. Remove old granular task files (or archive them)
|
||||
|
||||
## Benefits of This Approach
|
||||
|
||||
Reference in New Issue
Block a user