Skip to content

Latest commit

 

History

History
167 lines (166 loc) · 5.63 KB

File metadata and controls

167 lines (166 loc) · 5.63 KB

Repository Structure

engineering-playbook/
├── README.md                           # Main project README
├── CONTRIBUTING.md                     # Contribution guidelines
├── LICENSE                             # MIT License
├── CHANGELOG.md                        # Version history
├── STRUCTURE.md                        # This file
├── GETTING-STARTED.md

├── standards/                          # All technical standards
|  
│   ├── 01-overall/                     # Cross-cutting documentation
│   |   ├── README.md
│   |   ├── principles.md
│   |   ├── architecture-decision-records/
│   │   |   ├── 001-multi-cloud-strategy.md
│   │   |   ├── 002-event-driven-adoption.md
│   │   |   └── template.md
│   |   ├── examples/
│   |   ├── docs/
│   |   └── glossary.md
│   |
│   ├── 02-cloud-native/
│   |   ├── README.md
│   |   ├── architecture/
│   |   ├── examples/
│   |   └── docs/
|   |
│   ├── 03-microservices/
│   │   ├── README.md
│   │   ├── architecture/
│   │   ├── examples/
│   │   └── docs/
|   |
│   ├── 04-api-design/
│   │   ├── README.md
│   │   ├── architecture/
│   │   ├── examples/
│   │   │   ├── rest-api/
│   │   │   ├── graphql/
│   │   │   └── grpc/
│   │   ├── standards/
│   │   │   ├── rest-conventions.md
│   │   │   ├── versioning.md
│   │   │   └── error-handling.md
│   │   └── docs/
│   │
│   ├── 05-data-architecture/
│   │   ├── README.md
│   │   ├── architecture/
│   │   ├── examples/
│   │   │   ├── database-per-service/
│   │   │   ├── cqrs/
│   │   │   ├── data-lake/
│   │   │   ├── cdc/
│   │   │   └── data-mesh/
│   │   ├── patterns/
│   │   └── docs/
│   │
│   ├── 06-event-driven-architecture/
│   │   ├── README.md
│   │   ├── architecture/
│   │   ├── examples/
│   │   │   ├── kafka/
│   │   │   ├── aws-eventbridge/
│   │   │   ├── azure-event-grid/
│   │   │   └── event-sourcing/
│   │   ├── schemas/
│   │   ├── patterns/
│   │   └── docs/
|   |
│   ├── 07-devsecops/
│   │   ├── README.md
│   │   ├── architecture/
│   │   ├── examples/
│   │   │   ├── sast/
│   │   │   ├── dast/
│   │   │   ├── container-scanning/
│   │   │   └── iac-security/
│   │   ├── owasp-top-10/
│   │   │   └── implementations/
│   │   └── docs/
│   │
│   ├── 08-ci-cd-pipeline/
│   │   ├── README.md
│   │   ├── architecture/
│   │   │   ├── pipeline-blueprint.png
│   │   │   └── decision-tree.md
│   │   ├── examples/
│   │   │   ├── github-actions/
│   │   │   ├── aws-codepipeline/
│   │   │   └── azure-devops/
│   │   ├── quality-gates/
│   │   ├── docs/
│   │   │   ├── for-executives.md
│   │   │   ├── metrics.md
│   │   │   └── troubleshooting.md
│   │   └── tests/
│   │
│   ├── 09-observability/
│   │   ├── README.md
│   │   ├── architecture/
│   │   ├── examples/
│   │   │   ├── prometheus/
│   │   │   ├── elasticsearch-kibana/
│   │   │   ├── jaeger/
│   │   │   └── opentelemetry/
│   │   ├── dashboards/
│   │   │   ├── grafana/
│   │   │   └── kibana/
│   │   └── docs/
│   │
│   ├── 10-high-availability/
│   │   ├── README.md
│   │   ├── architecture/
│   │   ├── examples/
│   │   │   ├── aws/
│   │   │   └── azure/
│   │   ├── patterns/
│   │   │   ├── circuit-breaker.md
│   │   │   ├── bulkhead.md
│   │   │   └── retry-backoff.md
│   │   └── docs/
│   │
│   ├── 11-scaling-patterns/
│   │   ├── README.md
│   │   ├── architecture/
│   │   ├── examples/
│   │   │   ├── kubernetes/hpa/
│   │   │   ├── keda/
│   │   │   └── database-scaling/
│   │   └── docs/
│   │
│   └── 12-disaster-recovery/
│       ├── README.md
│       ├── architecture/
│       ├── examples/
│       │   ├── active-active/
│       │   ├── active-passive/
│       │   └── backup-restore/
│       ├── runbooks/
│       │   ├── failover-procedure.md
│       │   └── gameday-template.md
│       └── docs/
│
│
├── templates/                          # Templates for contributors
│   ├── STANDARD_TEMPLATE.md
│   ├── ARCHITECTURE_TEMPLATE.drawio
│   └── EXECUTIVE_GUIDE_TEMPLATE.md
│
├── examples/                           # Reusable code snippets
│   ├── python/
│   │   ├── requirements.txt
│   │   └── common/
│   ├── terraform/
│   │   └── modules/
│   ├── kubernetes/
│   │   └── manifests/
│   └── scripts/
│
└── tools/                              # Utility scripts
    ├── validate-standard.sh
    ├── generate-readme.py
    └── deploy-examples.sh