Skip to content

Commit 3d80ccf

Browse files
authored
docs: archive obsolete documentation and improve cross-references (#108)
- Archive historical documents to docs/archive/: - IMPROVEMENTS_2025-11-19.md (point-in-time PR summary) - NEW_TESTS_SUMMARY.md (historical test addition summary) - PHASE_4_SUMMARY.md (phase completion report) - TEST_VALIDATION_REPORT.md (point-in-time validation report) - Add cross-references between related documents: - UPGRADE_GUIDE.md ↔ MIGRATION_GUIDE.md - DISASTER_RECOVERY.md ↔ ROLLBACK_PROCEDURES.md - All guides now link to related troubleshooting docs - Update docs/README.md: - Remove references to archived documents - Update documentation coverage table - Add note about archive location - Update document dates and version numbers
1 parent 5f84f7a commit 3d80ccf

File tree

9 files changed

+35
-28
lines changed

9 files changed

+35
-28
lines changed

docs/DISASTER_RECOVERY.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22

33
Step-by-step procedures for recovering from infrastructure failures, including complete environment loss, Vault data loss, database corruption, and network issues. Target RTO: 30 minutes.
44

5+
**Last Updated:** 2025-12-30
6+
7+
> **Related Documentation:**
8+
> - For rolling back upgrades or changes, see [ROLLBACK_PROCEDURES.md](./ROLLBACK_PROCEDURES.md)
9+
> - For upgrade procedures, see [UPGRADE_GUIDE.md](./UPGRADE_GUIDE.md)
10+
> - For troubleshooting, see [TROUBLESHOOTING.md](./TROUBLESHOOTING.md)
11+
512
## Table of Contents
613

714
- [Overview](#overview)

docs/MIGRATION_GUIDE.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
# Migration Guide
22

3-
Step-by-step instructions for migrating from legacy configurations to DevStack Core v1.3.0+, including AppRole authentication and service profiles.
3+
Step-by-step instructions for migrating from legacy configurations to DevStack Core v1.3.0+, including AppRole authentication and TLS encryption.
44

5-
**Version:** 1.0 | **Last Updated:** November 19, 2025
5+
**Version:** 1.1 | **Last Updated:** 2025-12-30
6+
7+
> **Related Documentation:**
8+
> - For version upgrades and service upgrades, see [UPGRADE_GUIDE.md](./UPGRADE_GUIDE.md)
9+
> - For disaster recovery procedures, see [DISASTER_RECOVERY.md](./DISASTER_RECOVERY.md)
10+
> - For detailed rollback procedures, see [ROLLBACK_PROCEDURES.md](./ROLLBACK_PROCEDURES.md)
611
712
---
813

docs/README.md

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -91,27 +91,16 @@ This directory contains comprehensive documentation for the DevStack Core projec
9191
- Test environment setup
9292
- Test execution guidelines
9393
- Coverage goals and metrics
94+
- 571+ tests across 50 bash scripts
9495

95-
- **[RUST_API_TESTING_GUIDE.md](./RUST_API_TESTING_GUIDE.md)** - Rust HTTP API testing guide (NEW)
96+
- **[RUST_API_TESTING_GUIDE.md](./RUST_API_TESTING_GUIDE.md)** - Rust HTTP API testing guide
9697
- Comprehensive Actix-web testing patterns
9798
- Unit tests vs integration tests organization
9899
- Testing best practices (positive, negative, edge cases)
99100
- Common testing crates and complete examples
100101
- Async testing with tokio and actix_rt
101102
- Production-ready testing patterns
102103

103-
- **[TEST_VALIDATION_REPORT.md](./TEST_VALIDATION_REPORT.md)** - Phase 0-2 validation results (NEW - Nov 2025)
104-
- 100% test pass rate confirmation (494+ tests)
105-
- Issues found and resolved during validation
106-
- Performance metrics and security validation
107-
- Production readiness assessment
108-
109-
- **[NEW_TESTS_SUMMARY.md](./NEW_TESTS_SUMMARY.md)** - Extended test suite summary
110-
- New test suites added to the project
111-
- Coverage of Vault, PostgreSQL, PgBouncer, Observability
112-
- 40+ new test cases across 4 suites
113-
- Test statistics and implementation details
114-
115104
### Architecture & Design
116105

117106
- **[ARCHITECTURE.md](./ARCHITECTURE.md)** - Complete architecture deep-dive
@@ -328,19 +317,18 @@ See [CONTRIBUTING.md](../.github/CONTRIBUTING.md) for guidelines on:
328317

329318
| Category | Files | Status |
330319
|----------|-------|--------|
331-
| Project Information | 1 | ✅ Complete |
320+
| Getting Started | 4 | ✅ Complete |
332321
| Security | 2 | ✅ Complete |
333-
| Testing | 4 | ✅ Complete |
322+
| Testing | 2 | ✅ Complete |
334323
| Architecture | 1 | ✅ Complete |
335-
| Service Profiles (v1.3) | 3 | ✅ Complete |
336-
| Operational Guides | 9 | ✅ Complete |
337-
| Upgrade Procedures | 1 | ✅ Complete |
324+
| Service Profiles | 3 | ✅ Complete |
325+
| Operational Guides | 12 | ✅ Complete |
338326
| API Patterns | 1 | ✅ Complete |
339327
| Reference Apps | 6 | ✅ Complete |
340328
| VoIP Infrastructure | 3 | ✅ Complete (voip/ subdirectory) |
341-
| **Total Core Documentation Files** | **~31** | **99% Coverage** |
329+
| **Total Core Documentation Files** | **~34** | **Complete** |
342330

343-
**Note:** Work-in-progress files (task tracking, test results) are now located in `docs/.private/` (gitignored).
331+
**Note:** Historical phase summaries and test reports are archived in `docs/archive/`. Work-in-progress files are in `docs/.private/` (gitignored).
344332

345333
## Useful Resources
346334

docs/ROLLBACK_PROCEDURES.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,12 @@
22

33
Procedures for safely rolling back DevStack Core changes, including database restores, service reverts, and configuration recovery.
44

5-
**Document Version:** 1.0 | **Created:** November 14, 2025
5+
**Document Version:** 1.1 | **Last Updated:** 2025-12-30
6+
7+
> **Related Documentation:**
8+
> - For disaster recovery (complete environment loss), see [DISASTER_RECOVERY.md](./DISASTER_RECOVERY.md)
9+
> - For upgrade procedures, see [UPGRADE_GUIDE.md](./UPGRADE_GUIDE.md)
10+
> - For AppRole/TLS migration rollback, see [MIGRATION_GUIDE.md](./MIGRATION_GUIDE.md)
611
712
---
813

@@ -26,7 +31,6 @@ This document provides step-by-step procedures to roll back DevStack Core improv
2631
- **Quick validation:** `./tests/test-rollback-simple.sh` (⭐ Recommended - 30 seconds)
2732
- **Comprehensive:** `./tests/test-rollback-comprehensive.sh` (All databases - 2 minutes)
2833
- **All test scripts:** See [Rollback Testing](#rollback-testing) section below
29-
- **Test results:** [TEST_VALIDATION_REPORT.md](./TEST_VALIDATION_REPORT.md)
3034

3135
### When to Roll Back
3236

@@ -626,8 +630,6 @@ DevStack Core includes **4 automated rollback test scripts** to validate rollbac
626630

627631
**Recommended Test:** Use `test-rollback-simple.sh` for validation - it's proven to work and validates core rollback procedures (AppRole ↔ Root Token migration).
628632

629-
**Latest Test Results:** See [TEST_VALIDATION_REPORT.md](./TEST_VALIDATION_REPORT.md) for comprehensive testing analysis.
630-
631633
### Running Rollback Tests
632634

633635
```bash
@@ -667,7 +669,7 @@ The following improvements have been implemented in test scripts:
667669
- Prerequisites validation before test execution
668670
- Automated cleanup on test failures
669671

670-
See [TEST_VALIDATION_REPORT.md](./TEST_VALIDATION_REPORT.md) for detailed test results and analysis.
672+
See [TESTING_APPROACH.md](./TESTING_APPROACH.md) for test methodology and [tests/TEST_COVERAGE.md](../tests/TEST_COVERAGE.md) for detailed coverage analysis.
671673

672674
### Pre-Rollback Test
673675

docs/UPGRADE_GUIDE.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
# Upgrade Guide
22

33
**Version:** 1.3.0
4-
**Last Updated:** 2025-01-18
4+
**Last Updated:** 2025-12-30
55

66
Complete guide for upgrading DevStack Core versions, service versions, and migrating between profiles.
77

8+
> **Related Documentation:**
9+
> - For AppRole and TLS migration specifically, see [MIGRATION_GUIDE.md](./MIGRATION_GUIDE.md)
10+
> - For disaster recovery procedures, see [DISASTER_RECOVERY.md](./DISASTER_RECOVERY.md)
11+
> - For detailed rollback procedures, see [ROLLBACK_PROCEDURES.md](./ROLLBACK_PROCEDURES.md)
12+
813
---
914

1015
## Table of Contents
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)