|
1 | 1 | # Refactoring Documentation
|
2 | 2 |
|
3 |
| -This directory contains cross-cutting refactoring documentation. Component-specific |
4 |
| -refactoring documentation has been moved to appropriate locations. |
| 3 | +This directory contains cross-cutting refactoring documentation for the Torrust Tracker Demo project. |
5 | 4 |
|
6 |
| -## File Relocations (July 2025) |
| 5 | +## 🎯 Active Refactoring Projects |
7 | 6 |
|
8 |
| -The following files have been **moved** to better organize documentation: |
| 7 | +### Infrastructure Twelve-Factor Refactoring |
9 | 8 |
|
10 |
| -### Moved to `infrastructure/docs/refactoring/twelve-factor-refactor/` |
| 9 | +**Status**: 🚧 IN PROGRESS (Foundation Complete) |
11 | 10 |
|
12 |
| -- `twelve-factor-implementation-status.md` → `current-status.md` |
13 |
| -- `twelve-factor-refactoring-completed.md` → `integration-testing-improvements.md` |
| 11 | +- **Documentation**: [Twelve-Factor Refactoring Plan](../infrastructure/docs/refactoring/twelve-factor-refactor/README.md) |
| 12 | +- **Current State**: Infrastructure/application separation complete, configuration management in progress |
| 13 | +- **Recent Achievement**: 100% reliable integration testing workflow |
| 14 | +- **Next Phase**: Template-based configuration management system |
14 | 15 |
|
15 |
| -**Reason**: These documents are specific to infrastructure twelve-factor refactoring |
16 |
| -and belong with the related implementation documentation. |
| 16 | +## 📋 Completed Improvements (July 2025) |
17 | 17 |
|
18 |
| -## Current Refactoring Documentation |
| 18 | +### ✅ Integration Testing Workflow |
19 | 19 |
|
20 |
| -### Infrastructure Twelve-Factor Refactoring |
| 20 | +- **Local repository deployment**: Test changes without pushing to GitHub |
| 21 | +- **SSH authentication**: Reliable key-based authentication |
| 22 | +- **Health validation**: 14/14 endpoint validation tests passing |
| 23 | +- **Database migration**: Local environment using MySQL (production parity) |
| 24 | + |
| 25 | +### ✅ Infrastructure/Application Separation |
| 26 | + |
| 27 | +- **Clean separation**: Infrastructure provisioning vs application deployment |
| 28 | +- **Twelve-factor compliance**: Proper build/release/run stage separation |
| 29 | +- **Backward compatibility**: Legacy commands work with deprecation warnings |
| 30 | + |
| 31 | +## 📚 Documentation Structure |
| 32 | + |
| 33 | +```text |
| 34 | +docs/refactoring/ |
| 35 | +├── README.md # This navigation file |
| 36 | +├── integration-test-refactor-summary.md # Integration testing summary |
| 37 | +└── ../infrastructure/docs/refactoring/ |
| 38 | + └── twelve-factor-refactor/ |
| 39 | + ├── README.md # Complete twelve-factor plan |
| 40 | + └── migration-guide.md # Implementation guide |
| 41 | +``` |
21 | 42 |
|
22 |
| -- **Location**: `infrastructure/docs/refactoring/twelve-factor-refactor/` |
23 |
| -- **Main Plan**: [README.md](../infrastructure/docs/refactoring/twelve-factor-refactor/README.md) |
24 |
| -- **Current Status**: [current-status.md](../infrastructure/docs/refactoring/twelve-factor-refactor/current-status.md) |
25 |
| -- **Recent Improvements**: [integration-testing-improvements.md](../infrastructure/docs/refactoring/twelve-factor-refactor/integration-testing-improvements.md) |
| 43 | +## 🚀 Quick Start |
26 | 44 |
|
27 |
| -### Integration Testing |
| 45 | +To understand the current state and next steps: |
28 | 46 |
|
29 |
| -- **Recent Improvements**: [integration-test-refactor-summary.md](./integration-test-refactor-summary.md) |
| 47 | +1. **Read the main plan**: [Twelve-Factor Refactoring Plan](../infrastructure/docs/refactoring/twelve-factor-refactor/README.md) |
| 48 | +2. **Try the working workflow**: Follow the working commands in the plan |
| 49 | +3. **Contribute**: Check the "Next Steps" section for immediate priorities |
30 | 50 |
|
31 | 51 | ## Navigation
|
32 | 52 |
|
|
0 commit comments