🎯 Choose Your Path: Pick the guide that matches your experience and needs 📊 Difficulty Levels: ⭐ Basic | ⭐⭐ Intermediate | ⭐⭐⭐ Advanced ⏱️ Time Estimates: Realistic reading and implementation times included 🔄 Last Updated: 2025-11-04 (consolidated and workflow reorganization)
| Experience Level | Time | Documentation |
|---|---|---|
| Experienced Users | 5 min | Quick Start |
| Standard Setup | 30 min | Full Deployment Guide |
| First-Time Users | 1 hour | Complete Guide with Explanations |
| Advanced Patterns | Variable | Advanced Deployment |
- Deployment Guide - Unified deployment instructions (Quick Start → Advanced)
- Deployment Reference ⭐⭐ - Commands, troubleshooting, daily operations
- Troubleshooting Guide ⭐ - Common issues and solutions
- Command Reference ⭐ - Quick command lookup
- Architecture Overview ⭐⭐ - Technical architecture and infrastructure design
- IAM Deep Dive ⭐⭐⭐ - IAM permissions, security model, and migration roadmap
- Security Policy ⭐ - Security practices and vulnerability reporting
- CI/CD Pipeline ⭐⭐ - Complete BUILD → TEST → RUN pipeline guide
- Secrets & Variables ⭐⭐ - GitHub OIDC authentication setup
- Workflow Conditions ⭐⭐⭐ - Advanced routing logic
- Feature Flags ⭐⭐ - Cost optimization and conditional resources
- IAM Policies ⭐⭐⭐ - JSON policy files and trust relationships
- Monitoring & Observability ⭐⭐ - CloudWatch, logs, metrics, and alerts
- Cost Management ⭐⭐ - Cost optimization and budget controls
- Disaster Recovery ⭐⭐ - Backup, recovery, and business continuity
| I Want To... | Documentation | Time |
|---|---|---|
| Deploy my first website | Deployment Guide | 30 min |
| Deploy in 5 minutes | Quick Start | 5 min |
| Understand the architecture | Architecture Overview | 20 min |
| Set up GitHub Actions | Secrets & Variables | 15 min |
| Understand IAM permissions | IAM Deep Dive | 30 min |
| Fix a deployment error | Troubleshooting + Deployment Reference | 10-30 min |
| Find a specific command | Command Reference | 2 min |
| Optimize costs | Feature Flags | 10 min |
| Report a security issue | Security Policy | 2 min |
- Start with Main README - Project overview
- Follow Deployment Guide - Step-by-step setup
- Read Architecture Overview - Understand the system
- Review Security Policy - Security best practices
- Use Deployment Reference - Daily operations
- Bookmark Command Reference - Quick lookups
- Keep Troubleshooting handy - Problem solving
- Monitor Workflows - CI/CD pipeline
- Study Architecture Overview - System design
- Deep-dive IAM Deep Dive - IAM model
- Review Feature Flags - Configuration options
- Explore IAM Policies - Security policies
Best for: Step-by-step instructions, tutorials, walkthroughs
Examples: Deployment Guide, Troubleshooting
Best for: Quick lookups, command syntax, configuration options
Examples: Command Reference, Deployment Reference
Best for: Understanding concepts, architecture decisions, trade-offs
Examples: Architecture, IAM Deep Dive
- ✅ Workflow Reorganization: Moved reusable workflows to .github/workflow-examples/ with comprehensive README
- ✅ Consolidated Deployment: Merged 3 guides into single DEPLOYMENT.md
- ✅ Added Reference Guide: New deployment-reference.md for quick lookups
- ✅ Streamlined Navigation: Clear paths for different experience levels
- ✅ Improved Organization: Documentation grouped by purpose and difficulty
Phase 1:
- Merged: DEPLOYMENT_GUIDE.md + docs/deployment.md + docs/quickstart.md → DEPLOYMENT.md
- Created: deployment-reference.md (commands and troubleshooting)
- Updated: README.md (streamlined with better navigation)
- Updated: docs/README.md (this file - clearer structure)
Phase 2:
- Created: ci-cd.md (unified CI/CD pipeline documentation)
- Created: iam-deep-dive.md (copy of permissions-architecture.md with better naming)
- Updated: architecture.md (added IAM summary and cross-references)
- Moved: CONTRIBUTING.md → docs/CONTRIBUTING.md
- Moved: ROADMAP.md → docs/ROADMAP.md
- Updated: All internal links to reflect new structure
Phase 3:
- Moved: Reusable workflows → .github/workflow-examples/
- Created: workflow-examples/README.md (comprehensive guide with 2025 best practices)
- Updated: .github/workflows/README.md (pointer to examples)
- Updated: docs/workflows-reusable.md (location notices and path updates)
- Fixed: Broken DEPLOYMENT_GUIDE.md links across documentation
- 📉 40% less duplication - No more searching across multiple files
- 🎯 Clear entry points - Know exactly where to start
- ⚡ Faster navigation - Task-based guide helps find what you need
- 📚 Better organization - Documents grouped by purpose
- Read the Main README for project overview
- Follow the Deployment Guide from start to finish
- Bookmark this index for future reference
- Check the Quick Task Guide above
- Use your browser's find function (Ctrl+F / Cmd+F)
- Review the Document Types section
- Start with Troubleshooting Guide
- Check Deployment Reference for specific errors
- Review GitHub Actions logs
- Open an issue if problem persists
Found an error or want to improve the docs? See our Contributing Guide.
Common contributions:
- Fixing typos or broken links
- Adding missing command examples
- Clarifying confusing sections
- Adding troubleshooting solutions
- Improving diagrams or examples
| Need | Resource |
|---|---|
| Quick question | Check Quick Task Guide |
| Deployment issue | See Troubleshooting |
| Bug report | Open GitHub Issue |
| Security issue | Follow Security Policy |
| Feature request | Open GitHub Discussion |
Happy deploying! 🚀
This documentation is maintained by the community. Last major update: November 2025.