3bf47efa2b
- Add Well-Architected Framework implementation guide covering all 5 pillars - Create Well-Architected Terraform module (cost, operations, performance, reliability, security) - Add Cloud for Sovereignty compliance guide - Implement data residency policies and enforcement - Add operational sovereignty features (CMK, independent logging) - Configure compliance monitoring and reporting - Add budget management and cost optimization - Implement comprehensive security controls - Add backup and disaster recovery automation - Create performance optimization resources (Redis, Front Door) - Add operational excellence tools (Log Analytics, App Insights, Automation)
Documentation Index
Last Updated: 2025-01-27
Purpose: Central navigation hub for all project documentation
Quick Navigation
📖 Navigation Guide - Complete documentation navigation
Documentation by Category
🚀 Getting Started
- Main README - Project overview and quick start
- Project Structure - Complete structure guide
- Quick Start Guide - Development setup
📐 Architecture
- Architecture Overview - System architecture
- Cloud for Sovereignty Landing Zone - Complete architecture
- Sovereignty Landing Zone Summary - Executive summary
🚢 Deployment
- Deployment Overview - Deployment guide index
- Azure Environment Setup - Azure configuration
- Sovereignty Landing Zone Deployment - Multi-region deployment
- Azure CDN Setup - CDN configuration
- Entra VerifiedID Setup - Entra configuration
- Dotenv Setup - Environment variable configuration
🔌 Integrations
- Integrations Overview - Integration index
- Entra VerifiedID - Credential issuance guide
⚖️ Legal System
- Legal Documentation - Legal system overview
- Document Management - DMS documentation
- Implementation Guide - Implementation details
🏛️ Governance
- Governance Overview - Governance index
- Contributing Guidelines - How to contribute
- Security Policies - Security guidelines
📊 Reports & Status
- Reports Overview - Project reports index
- Comprehensive Project Review - Full project review
- Remaining Steps - Task list
- Task Completion Status - Progress tracking
Documentation by Role
For Developers
- Start: README
- Structure: PROJECT_STRUCTURE.md
- Architecture: Architecture Overview
- Service Docs:
services/*/README.md - Package Docs:
packages/*/README.md
For Infrastructure Engineers
- Infrastructure: Infrastructure README
- Terraform: Terraform Guide
- Kubernetes: K8s Guide
- Azure: Azure Deployment Guides
For Security Engineers
- Security: Security Policies
- Architecture: Architecture Security
- Compliance: Cloud for Sovereignty
For Project Managers
- Status: Task Completion Status
- Review: Comprehensive Review
- Summary: Sovereignty Landing Zone Summary
Documentation Structure
docs/
├── README.md # This file
├── NAVIGATION.md # Navigation guide
├── architecture/ # Architecture documentation
├── deployment/ # Deployment guides
│ └── azure/ # Azure-specific
├── integrations/ # Integration documentation
├── legal/ # Legal system documentation
├── governance/ # Governance & policies
└── reports/ # Project reports
Finding Documentation
By Topic
- Architecture:
docs/architecture/ - Deployment:
docs/deployment/ - Integrations:
docs/integrations/ - Legal:
docs/legal/ - Governance:
docs/governance/ - Reports:
docs/reports/
By File Type
- README.md: Directory overviews
- *_SETUP.md: Setup guides
- *_DEPLOYMENT.md: Deployment guides
- *_GUIDE.md: How-to guides
- *_SUMMARY.md: Executive summaries
Contributing to Documentation
- Follow existing structure
- Use consistent naming conventions
- Include examples and code snippets
- Keep documentation up to date
- Update navigation files
Quick Links
Last Updated: 2025-01-27