Skip to content

Commit da830f8

Browse files
committed
Docs: update references to the new files
1 parent 83d441c commit da830f8

8 files changed

Lines changed: 588 additions & 63 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ TourGuideAI follows semantic versioning (MAJOR.MINOR.PATCH) as defined in our [V
208208

209209
The project is currently in Release Candidate stage, preparing for the official 1.0.0 release scheduled for August 2025.
210210

211-
For detailed release plans, see our [1.0.0 Release Candidate Plan](docs/project_lifecycle/version_control/records/project.rc.1.0.0.release-plan.md).
211+
For detailed release plans, see our [1.0.0 Release Candidate 2 Plan](docs/project_lifecycle/version_control/records/project.rc2.1.0.0.release-plan.md).
212212

213213
## Testing Strategy
214214

deployment/production/README.md

Lines changed: 229 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,229 @@
1+
# TourGuideAI Production Deployment
2+
3+
This directory contains the production deployment configuration for TourGuideAI, implementing enterprise-grade infrastructure with comprehensive security, monitoring, and scalability features.
4+
5+
## Architecture Overview
6+
7+
The production deployment uses a Docker-based microservices architecture with the following components:
8+
9+
### Core Services
10+
- **Frontend**: React application served via Nginx with security hardening
11+
- **Backend**: Node.js/Express API server with authentication and rate limiting
12+
- **Database**: PostgreSQL with connection pooling and backup strategies
13+
- **Cache**: Redis for session management and API caching
14+
15+
### Security & Monitoring
16+
- **Nginx**: Reverse proxy with WAF, DDoS protection, and SSL termination
17+
- **Prometheus**: Metrics collection and monitoring
18+
- **Grafana**: Visualization and alerting dashboards
19+
20+
## File Structure
21+
22+
```
23+
deployment/production/
24+
├── docker-compose.yml # Multi-service production stack
25+
├── Dockerfile.frontend # Frontend production image
26+
├── Dockerfile.backend # Backend production image
27+
├── nginx.conf # Security-hardened web server config
28+
├── prometheus.yml # Monitoring configuration
29+
├── deploy.sh # Zero-downtime deployment script
30+
└── README.md # This documentation
31+
```
32+
33+
## Deployment Files
34+
35+
### docker-compose.yml
36+
Complete production stack configuration including:
37+
- **Services**: Frontend, backend, database, Redis, Nginx, Prometheus, Grafana
38+
- **Networks**: Isolated internal networks for security
39+
- **Volumes**: Persistent data storage for database and monitoring
40+
- **Health Checks**: Container health monitoring
41+
- **Resource Limits**: CPU and memory constraints
42+
- **Environment**: Production environment variables
43+
44+
### Dockerfile.frontend
45+
Multi-stage production build:
46+
- **Build Stage**: Creates optimized React bundle
47+
- **Production Stage**: Nginx-based serving with security hardening
48+
- **Security**: Non-root user, minimal attack surface
49+
- **Performance**: Gzip compression, caching headers
50+
51+
### Dockerfile.backend
52+
Node.js production container:
53+
- **Security**: Non-root user, minimal dependencies
54+
- **Health Checks**: Application health endpoints
55+
- **Performance**: Node.js production optimizations
56+
- **Monitoring**: Prometheus metrics integration
57+
58+
### nginx.conf
59+
Security-hardened reverse proxy:
60+
- **WAF**: Web Application Firewall protection
61+
- **Rate Limiting**: API and authentication endpoint protection
62+
- **Security Headers**: CSP, XSS protection, HSTS
63+
- **SSL/TLS**: Modern encryption and certificate management
64+
- **DDoS Protection**: Request rate limiting and connection limits
65+
66+
### prometheus.yml
67+
Comprehensive monitoring:
68+
- **Service Discovery**: Auto-discovery of containerized services
69+
- **Metrics Collection**: Application, system, and business metrics
70+
- **Retention**: Configurable data retention policies
71+
- **Alerting**: Integration with Grafana for notifications
72+
73+
### deploy.sh
74+
Zero-downtime deployment automation:
75+
- **Health Checks**: Verify service health before switching traffic
76+
- **Rollback**: Automatic rollback on deployment failure
77+
- **Backup**: Database backup before deployment
78+
- **Logging**: Comprehensive deployment logging
79+
- **Validation**: Pre-deployment environment validation
80+
81+
## Security Features
82+
83+
### Application Security
84+
- **Authentication**: JWT-based with role-based access control
85+
- **Authorization**: Fine-grained permission system
86+
- **Input Validation**: Comprehensive request validation
87+
- **Session Management**: Secure session handling with Redis
88+
89+
### Infrastructure Security
90+
- **Network Isolation**: Services isolated in private networks
91+
- **Container Security**: Non-root users, minimal base images
92+
- **Secret Management**: Environment-based secret injection
93+
- **SSL/TLS**: End-to-end encryption for all communications
94+
95+
### Monitoring Security
96+
- **Access Control**: Grafana authentication and authorization
97+
- **Audit Logging**: Security event logging and monitoring
98+
- **Intrusion Detection**: Anomaly detection and alerting
99+
100+
## Performance Optimizations
101+
102+
### Frontend Performance
103+
- **Bundle Optimization**: Code splitting and tree shaking
104+
- **Caching**: Browser and CDN caching strategies
105+
- **Compression**: Gzip and Brotli compression
106+
- **Asset Optimization**: Image and static asset optimization
107+
108+
### Backend Performance
109+
- **Connection Pooling**: Database connection management
110+
- **Caching**: Redis-based API response caching
111+
- **Rate Limiting**: Intelligent rate limiting to prevent abuse
112+
- **Load Balancing**: Nginx upstream load balancing
113+
114+
### Database Performance
115+
- **Indexing**: Optimized database indexes
116+
- **Connection Pooling**: Efficient connection management
117+
- **Backup Strategy**: Automated backup and recovery
118+
- **Monitoring**: Database performance monitoring
119+
120+
## Monitoring & Alerting
121+
122+
### Metrics Collection
123+
- **Application Metrics**: API response times, error rates, throughput
124+
- **System Metrics**: CPU, memory, disk, network utilization
125+
- **Business Metrics**: User engagement, feature usage
126+
- **Security Metrics**: Authentication failures, suspicious activity
127+
128+
### Dashboards
129+
- **System Overview**: High-level system health and performance
130+
- **Application Performance**: API and frontend performance metrics
131+
- **Security Dashboard**: Security events and threat monitoring
132+
- **Business Intelligence**: User analytics and feature metrics
133+
134+
### Alerting Rules
135+
- **Critical Alerts**: System outages, security breaches
136+
- **Warning Alerts**: Performance degradation, capacity issues
137+
- **Information Alerts**: Deployment notifications, maintenance windows
138+
139+
## Deployment Process
140+
141+
### Prerequisites
142+
1. **Environment Setup**: Production server with Docker and Docker Compose
143+
2. **Domain Configuration**: DNS records pointing to production server
144+
3. **SSL Certificates**: Valid SSL certificates for HTTPS
145+
4. **Environment Variables**: Production configuration and secrets
146+
147+
### Deployment Steps
148+
1. **Preparation**: Run pre-deployment health checks
149+
2. **Backup**: Create database and configuration backups
150+
3. **Build**: Build and tag new Docker images
151+
4. **Deploy**: Rolling deployment with health checks
152+
5. **Validation**: Post-deployment testing and validation
153+
6. **Monitoring**: Continuous monitoring for issues
154+
155+
### Rollback Process
156+
1. **Detection**: Automated failure detection
157+
2. **Isolation**: Isolate failed components
158+
3. **Restoration**: Restore previous working version
159+
4. **Verification**: Verify system stability
160+
5. **Investigation**: Post-mortem analysis
161+
162+
## Scaling Considerations
163+
164+
### Horizontal Scaling
165+
- **Load Balancing**: Multiple backend instances behind load balancer
166+
- **Database Scaling**: Read replicas and connection pooling
167+
- **Cache Scaling**: Redis clustering for high availability
168+
- **Frontend Scaling**: CDN and multi-region deployment
169+
170+
### Vertical Scaling
171+
- **Resource Monitoring**: CPU and memory utilization tracking
172+
- **Automatic Scaling**: Container resource limit adjustments
173+
- **Performance Tuning**: Application-level optimizations
174+
- **Capacity Planning**: Growth trend analysis and planning
175+
176+
## Maintenance Procedures
177+
178+
### Regular Maintenance
179+
- **Security Updates**: OS and dependency updates
180+
- **Database Maintenance**: Index optimization, vacuum operations
181+
- **Log Rotation**: Log file management and archival
182+
- **Backup Verification**: Regular backup integrity checks
183+
184+
### Monitoring Maintenance
185+
- **Dashboard Updates**: Keep monitoring dashboards current
186+
- **Alert Tuning**: Adjust alert thresholds based on historical data
187+
- **Capacity Reviews**: Regular capacity planning reviews
188+
- **Performance Analysis**: Ongoing performance optimization
189+
190+
## Troubleshooting
191+
192+
### Common Issues
193+
- **Service Startup Failures**: Container health check failures
194+
- **Performance Issues**: High response times or error rates
195+
- **Database Issues**: Connection timeouts or query performance
196+
- **Security Issues**: Authentication or authorization failures
197+
198+
### Diagnostic Tools
199+
- **Container Logs**: Docker and application log analysis
200+
- **Metrics Analysis**: Prometheus and Grafana monitoring
201+
- **Health Checks**: Service health endpoint monitoring
202+
- **Network Analysis**: Network connectivity and performance
203+
204+
### Emergency Procedures
205+
- **Incident Response**: Escalation procedures and emergency contacts
206+
- **Service Recovery**: Service restart and recovery procedures
207+
- **Data Recovery**: Database backup and recovery procedures
208+
- **Communication**: Stakeholder notification procedures
209+
210+
## Support and Documentation
211+
212+
### Technical Support
213+
- **Operations Team**: 24/7 production support contact
214+
- **Development Team**: Application-specific support
215+
- **Infrastructure Team**: System and network support
216+
- **Security Team**: Security incident response
217+
218+
### Additional Documentation
219+
- [Security Hardening Checklist](../docs/project_lifecycle/deployment/security/project.security-hardening-checklist.md)
220+
- [Monitoring Configuration Guide](../docs/project_lifecycle/deployment/plans/project.performance-optimization-plan.md)
221+
- [Deployment Pipeline Documentation](../docs/project_lifecycle/deployment/pipelines/project.deployment-pipeline.md)
222+
- [Test Stabilization Plan](../docs/project_lifecycle/all_tests/plans/project.test.stabilization-plan.md)
223+
224+
---
225+
226+
**Document Version**: 1.0
227+
**Last Updated**: Phase 8 Completion
228+
**Maintained By**: DevOps Team
229+
**Review Schedule**: Monthly or after major infrastructure changes

docs/project.document-inventory.md

8.02 KB

Process Documentation

File Purpose Update Frequency
docs/project_lifecycle/process_monitors/records/project.workflow-checklists.md Checklists for tracking workflow completion At phase start and when procedures are finished
docs/project.document-inventory.md This file - inventory of all documentation When documentation is added or modified
docs/project_lifecycle/process_monitors/records/project.phase-signoff.md Formal phase completion verification records At phase completion
docs/project_lifecycle/process_monitors/plans/phase6-beta-release-plan.md Phase 6 beta release plan At phase start
docs/project_lifecycle/process_monitors/plans/phase7-post-beta-enhancements-plan.md Phase 7 post-beta enhancements plan At phase start
docs/project_lifecycle/version_control/records/project.rc.1.0.0.release-plan.md Phase 8 online launch plan At Phase 8 start
docs/project_lifecycle/process_monitors/implementation_summary.md Summary of implementation progress When implementation status changes
docs/project_lifecycle/version_control/records/project.versions.md Version history and release notes After version completion
docs/project_lifecycle/version_control/records/project.beta.0.5.0-1.release-checklist.md Checklist for beta release deployment During beta release preparation
docs/project_lifecycle/version_control/records/project.beta.0.5.0-1.beta-tester-guide.md Guide for beta testers Before beta release and when beta program changes
docs/project_lifecycle/code_and_project_structure_refactors/plans/project.refactors.overall-plan.md Refactoring categorization and approach Before refactoring, quarterly review
docs/project_lifecycle/knowledge/project.lessons.md Centralized location for all project lessons After resolving challenges or insights
File Purpose Update Frequency
docs/project_lifecycle/process_monitors/records/project.workflow-checklists.md Checklists for tracking workflow completion At phase start and when procedures are finished
docs/project.document-inventory.md This file - inventory of all documentation When documentation is added or modified
docs/project_lifecycle/process_monitors/records/project.phase-signoff.md Formal phase completion verification records At phase completion
docs/project_lifecycle/process_monitors/plans/project.phase6-beta-release-plan.md Phase 6 beta release plan At phase start
docs/project_lifecycle/process_monitors/plans/project.phase7-post-beta-enhancements-plan.md Phase 7 post-beta enhancements plan At phase start
docs/project_lifecycle/process_monitors/plans/project.phase8-completion-summary.md Phase 8 completion documentation At Phase 8 completion
docs/project_lifecycle/process_monitors/implementation_summary.md Summary of implementation progress When implementation status changes
docs/project_lifecycle/version_control/records/project.versions.md Version history and release notes After version completion
docs/project_lifecycle/version_control/records/project.beta.0.5.0-1.release-checklist.md Checklist for beta release deployment During beta release preparation
docs/project_lifecycle/version_control/records/project.beta.0.5.0-1.beta-tester-guide.md Guide for beta testers Before beta release and when beta program changes
docs/project_lifecycle/code_and_project_structure_refactors/plans/project.refactors.overall-plan.md Refactoring categorization and approach Before refactoring, quarterly review
docs/project_lifecycle/knowledge/project.lessons.md Centralized location for all project lessons After resolving challenges or insights

Development Documentation

File Purpose Update Frequency
docs/project_lifecycle/deployment/pipelines/project.deployment-pipeline.md Deployment process documentation Before production release
docs/project_lifecycle/deployment/plans/project.deployment-pipeline-plan.md Detailed deployment strategy Before deployment pipeline implementation
docs/project_lifecycle/deployment/plans/project.performance-optimization-plan.md Performance strategy and targets Before optimization work
docs/project_lifecycle/deployment/plans/project.performance-implementation-plan.md Implementation details for performance Before performance feature implementation
docs/project_lifecycle/deployment/plans/project.cdn-implementation-plan.md CDN implementation strategy with CI/CD integration Updated with CDN implementation progress
docs/project_lifecycle/deployment/records/project.cdn-implementation-summary.md Summary of implemented CDN components When CDN implementation changes
docs/project_lifecycle/code_and_project_structure_refactors/plans/project.refactors.cdn-plan.md Plan for CDN code refactoring Before CDN refactoring work
docs/project_lifecycle/code_and_project_structure_refactors/records/project.refactors.cdn-completed.md Documentation of completed CDN refactors After CDN refactoring
models/README.md Documentation for AI models and resources When model architecture changes
tourai_platform/README.md Documentation for TourAI platform When platform functionality changes
scripts/run-security-audit.js Script for running security scans with OWASP ZAP or in mock mode When security scanning process changes
scripts/deploy-to-cdn.js Script for deploying assets to CDN When CDN deployment process changes
File Purpose Update Frequency
docs/project_lifecycle/deployment/pipelines/project.deployment-pipeline.md Deployment process documentation Before production release
docs/project_lifecycle/deployment/plans/project.deployment-pipeline-plan.md Detailed deployment strategy Before deployment pipeline implementation
docs/project_lifecycle/deployment/plans/project.performance-optimization-plan.md Performance strategy and targets Before optimization work
docs/project_lifecycle/deployment/plans/project.performance-implementation-plan.md Implementation details for performance Before performance feature implementation
docs/project_lifecycle/deployment/plans/project.cdn-implementation-plan.md CDN implementation strategy with CI/CD integration Updated with CDN implementation progress
docs/project_lifecycle/deployment/records/project.cdn-implementation-summary.md Summary of implemented CDN components When CDN implementation changes
docs/project_lifecycle/code_and_project_structure_refactors/plans/project.refactors.cdn-plan.md Plan for CDN code refactoring Before CDN refactoring work
docs/project_lifecycle/code_and_project_structure_refactors/records/project.refactors.cdn-completed.md Documentation of completed CDN refactors After CDN refactoring
scripts/run-security-audit.js Script for running security scans with OWASP ZAP or in mock mode When security scanning process changes
scripts/deploy-to-cdn.js Script for deploying assets to CDN When CDN deployment process changes

Production Infrastructure Documentation

File Purpose Update Frequency
deployment/production/docker-compose.yml Production Docker stack configuration When production services change
deployment/production/Dockerfile.frontend Frontend production Docker image When frontend build process changes
deployment/production/Dockerfile.backend Backend production Docker image When backend build process changes
deployment/production/nginx.conf Production Nginx configuration with security hardening When web server configuration changes
deployment/production/prometheus.yml Monitoring and metrics configuration When monitoring requirements change
deployment/production/deploy.sh Zero-downtime deployment script When deployment process changes
deployment/production/README.md Comprehensive production deployment guide When production infrastructure changes
docs/project_lifecycle/deployment/security/project.security-hardening-checklist.md Comprehensive security hardening checklist Before production deployment

Testing Documentation

File Purpose Update Frequency
docs/project_lifecycle/all_tests/plans/project.tests.frontend-plan.md Comprehensive frontend testing strategy When frontend test approach changes
docs/project_lifecycle/all_tests/plans/project.tests.backend-plan.md Comprehensive backend testing strategy When backend test approach changes
docs/project_lifecycle/all_tests/results/project.test-execution-results.md Test execution status and next steps After each test run
docs/project_lifecycle/all_tests/results/test-results-summary.md Summary of test results After test completion
docs/project_lifecycle/all_tests/results/project.tests.frontend-results-template.md Template for frontend test execution results Used to create date-specific result files
docs/project_lifecycle/all_tests/results/project.tests.backend-results-template.md Template for backend test execution results Used to create date-specific result files
docs/project_lifecycle/all_tests/results/coverage-report.md Test coverage metrics and trends After each test run
docs/project_lifecycle/all_tests/references/project.test-scenarios.md Detailed test scenarios with metrics Before feature implementation
docs/project_lifecycle/all_tests/references/project.test-user-story.md Mock user journeys for testing Before feature implementation
docs/project_lifecycle/all_tests/references/test-user-stories.md User stories for test scenario generation Updated as features evolve
docs/project_lifecycle/all_tests/references/project.tests.test-patterns.md Standard test patterns and conventions When test patterns evolve
docs/project_lifecycle/all_tests/references/project.tests.mock-strategies.md Documentation of mocking approaches for services When mock strategies change
docs/project_lifecycle/all_tests/references/project.test_organization.md Guide to test organization in the project When test structure changes
docs/project_lifecycle/all_tests/results/stability-test/README.md Information about stability test results When stability test structure changes
docs/project_lifecycle/all_tests/results/sync-service/README.md Information about SyncService test results When SyncService test structure changes
docs/project_lifecycle/all_tests/results/user-journey/README.md Information about user journey test results When user journey test structure changes
docs/project_lifecycle/all_tests/results/security-reports/README.md Information about security scanning and reports When security scanning process changes
docs/project_lifecycle/all_tests/README.md Main test documentation overview When test structure changes
tests/README.md Main test suite documentation When test structure changes
tests/smoke/README.md Smoke tests documentation When smoke tests change
tests/cross-browser/README.md Cross-browser tests documentation When cross-browser tests change
tests/load/README.md Load tests documentation When load tests change
tests/security/README.md Security tests documentation When security tests change
tests/all_tests/README.md All tests documentation including stability tests When stability tests change
tests/config/README.md Test configuration documentation When test configuration changes
File Purpose Update Frequency
docs/project_lifecycle/all_tests/plans/project.tests.frontend-plan.md Comprehensive frontend testing strategy When frontend test approach changes
docs/project_lifecycle/all_tests/plans/project.tests.backend-plan.md Comprehensive backend testing strategy When backend test approach changes
docs/project_lifecycle/all_tests/plans/project.test.stabilization-plan.md Test stabilization implementation plan During test improvement phases
docs/project_lifecycle/all_tests/results/project.test-execution-results.md Test execution status and next steps After each test run
docs/project_lifecycle/all_tests/results/test-results-summary.md Summary of test results After test completion
docs/project_lifecycle/all_tests/results/project.tests.frontend-results-template.md Template for frontend test execution results Used to create date-specific result files
docs/project_lifecycle/all_tests/results/project.tests.backend-results-template.md Template for backend test execution results Used to create date-specific result files
docs/project_lifecycle/all_tests/results/coverage-report.md Test coverage metrics and trends After each test run
docs/project_lifecycle/all_tests/references/project.test-scenarios.md Detailed test scenarios with metrics Before feature implementation
docs/project_lifecycle/all_tests/references/project.test-user-story.md Mock user journeys for testing Before feature implementation
docs/project_lifecycle/all_tests/references/test-user-stories.md User stories for test scenario generation Updated as features evolve
docs/project_lifecycle/all_tests/references/project.tests.test-patterns.md Standard test patterns and conventions When test patterns evolve
docs/project_lifecycle/all_tests/references/project.tests.mock-strategies.md Documentation of mocking approaches for services When mock strategies change
docs/project_lifecycle/all_tests/references/project.test_organization.md Guide to test organization in the project When test structure changes
docs/project_lifecycle/all_tests/results/stability-test/README.md Information about stability test results When stability test structure changes
docs/project_lifecycle/all_tests/results/sync-service/README.md Information about SyncService test results When SyncService test structure changes
docs/project_lifecycle/all_tests/results/user-journey/README.md Information about user journey test results When user journey test structure changes
docs/project_lifecycle/all_tests/results/security-reports/README.md Information about security scanning and reports When security scanning process changes
docs/project_lifecycle/all_tests/README.md Main test documentation overview When test structure changes
tests/README.md Main test suite documentation When test structure changes
tests/smoke/README.md Smoke tests documentation When smoke tests change
tests/cross-browser/README.md Cross-browser tests documentation When cross-browser tests change
tests/load/README.md Load tests documentation When load tests change
tests/security/README.md Security tests documentation When security tests change
tests/all_tests/README.md All tests documentation including stability tests When stability tests change
tests/config/README.md Test configuration documentation When test configuration changes

Test Configuration Files

File Purpose Update Frequency
tests/config/jest/frontend.config.js Jest configuration for frontend tests When frontend test setup changes
tests/config/jest/backend.config.js Jest configuration for backend tests When backend test setup changes
tests/config/jest/integration.config.js Jest configuration for integration tests When integration test setup changes
tests/config/mocks/componentMocks.js Standardized component mocks for testing When component structure changes
tests/config/mocks/serviceMocks.js Comprehensive service mocks for testing When service interfaces change

Test-Driven Refactoring Documentation

PrototypeApplication Context Documentation

File Purpose Update Frequency
src/contexts/AuthContext.js Authentication state management implementation When authentication features change
src/contexts/NotificationContext.js Notification system implementation When notification features change
src/contexts/README.md Overview of React contexts in the application When context structure changes

Component Documentation

File Purpose Update Frequency
src/components/Navbar.js Main navigation component implementation When navigation features change
src/components/Navbar.css Navbar styling and responsive design When navigation UI changes

Version Control Documentation

File Purpose Update Frequency
docs/project_lifecycle/version_control/records/project.rc1.1.0.0.release-plan.md Release Candidate 1 planning documentation During RC1 phase
docs/project_lifecycle/version_control/records/project.rc2.1.0.0.release-plan.md Release Candidate 2 planning documentation During RC2 phase

Prototype Documentation

Reference Documentation

Technical Documentation

Recently Removed Files

The following files were removed during Phase 8 cleanup and their functionality has been integrated into other documents:

  • deployment-checklist.md → Integrated into production deployment files
  • deployment-environment-setup.md → Replaced by deployment/production/ configuration files
  • docs/project_lifecycle/version_control/records/project.1.0.0-RC2-release-plan.md → Superseded by project.rc2.1.0.0.release-plan.md
  • docs/project_lifecycle/all_tests/plans/project.test-stabilization-plan.md → Replaced by project.test.stabilization-plan.md
  • docs/project_lifecycle/version_control/records/project.1.0.0-RC2-deployment-readiness-summary.md → Integrated into Phase 8 completion summary
  • docs/project_lifecycle/version_control/records/project.phase8-completion-summary.md → Moved to docs/project_lifecycle/process_monitors/plans/project.phase8-completion-summary.md

Document Update Process

  1. When creating a new document:

    • Check this inventory to see if a similar document already exists
    • Use consistent naming conventions (project.category-purpose.md)
    • Update this inventory to include the new document
  2. When updating a document:

    • Ensure changes align with the stated purpose of the document
    • Update any linked or related documents to maintain consistency
  3. Document review should be performed:

    • At the end of each development phase
    • When making significant architectural changes
    • Before release milestones
  4. Production deployment documentation should be updated:

    • When infrastructure configuration changes
    • After security hardening updates
    • When monitoring or alerting setup changes

docs/project_lifecycle/deployment/plans/project.cdn-implementation-plan.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ If the deployment to CDN fails through the CI/CD pipeline:
324324
- [CloudFront Cache Invalidation API](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html)
325325

326326
## Related Documents
327-
- [Phase 8 Online Launch Plan](../../../project.phase8-online-launch-plan.md)
327+
- [Phase 8 Completion Summary](../../process_monitors/plans/project.phase8-completion-summary.md)
328328
- [TourGuideAI Architecture Design](../../../ARCHITECTURE.md)
329329
- [Deployment Pipeline Documentation](../pipelines/project.deployment-pipeline.md)
330330
- [CI/CD Workflow](/.github/workflows/ci-cd.yml)

docs/project_lifecycle/deployment/security/project.security-hardening-checklist.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -356,6 +356,6 @@ This document provides a comprehensive security hardening checklist for TourGuid
356356
**Approval Required From**: CISO, Technical Lead, Compliance Officer
357357

358358
**Related Documents**:
359-
- [Incident Response Plan](project.incident-response-plan.md)
360-
- [Privacy Policy](project.privacy-policy.md)
361-
- [Security Training Materials](project.security-training.md)
359+
- Incident Response Plan (planned)
360+
- Privacy Policy (planned)
361+
- Security Training Materials (planned)

docs/project_lifecycle/version_control/records/project.rc2.1.0.0.release-plan.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ This RC2 release plan requires approval from:
310310
**Next Review**: Weekly during implementation
311311

312312
**Related Documents**:
313-
- [Phase 8 Online Launch Plan](project.phase8-online-launch-plan.md)
314-
- [CDN Implementation Plan](../deployment/plans/project.cdn-implementation-plan.md)
315-
- [Security Hardening Checklist](../security/project.security-hardening-checklist.md)
316-
- [Test Stabilization Plan](../all_tests/plans/project.test-stabilization-plan.md)
313+
- [Phase 8 Completion Summary](../../process_monitors/plans/project.phase8-completion-summary.md)
314+
- [CDN Implementation Plan](../../deployment/plans/project.cdn-implementation-plan.md)
315+
- [Security Hardening Checklist](../../deployment/security/project.security-hardening-checklist.md)
316+
- [Test Stabilization Plan](../../all_tests/plans/project.test.stabilization-plan.md)

0 commit comments

Comments
 (0)