Topic Index
Find content by topic. Each entry links to the most relevant page and includes cross-references to related content.
A¶
Ansible¶
- Style Guide: Ansible
- Refactoring Examples: Ansible Refactoring
- Example Role: Ansible Role Example
- Template: CONTRACT.md Template (includes Ansible contracts)
- See also: YAML, Infrastructure as Code, Configuration Management
Anti-Patterns¶
- Overview: Common Anti-Patterns
- Code Smell Catalog: Code Smell Catalog
- Azure-Specific: Azure Anti-Patterns
- See also: Refactoring, Code Quality
Architecture Decision Records (ADR)¶
- Template: ADR Template
- See also: Governance, Templates
Automation¶
- Pre-commit Hooks: Pre-commit Hooks Guide
- CI/CD Pipelines: GitHub Actions Guide
- Changelog Automation: Changelog Automation
- Dependabot: Dependabot Auto-Merge
- Manual to Automated Tutorial: From Manual to Automated
- See also: CI/CD, Pre-commit Hooks, Build Tools
Azure¶
- Cloud Provider Guide: Microsoft Azure
- Azure Bicep: Bicep Style Guide
- Anti-Patterns: Azure Anti-Patterns
- See also: Cloud Providers, Infrastructure as Code
AWS¶
- CloudFormation: CloudFormation Style Guide
- AWS CDK: CDK Style Guide
- Terraform Examples: Terraform Module Example
- See also: Cloud Providers, Infrastructure as Code
B¶
Bash¶
- Style Guide: Bash
- Refactoring Examples: Bash Refactoring
- Shell Aliases: Shell Aliases & Functions
- REPL Usage: REPL & Interactive Shells
- See also: ShellCheck, Scripting
Build Tools¶
- Makefile: Makefile Style Guide
- Task & Just: Task Runners
- See also: Automation
C¶
CI/CD¶
- GitHub Actions Guide: GitHub Actions Guide
- GitHub Actions Style: GitHub Actions Style Guide
- GitLab CI Guide: GitLab CI Guide
- GitLab CI Style: GitLab CI Style Guide
- Jenkins Guide: Jenkins Pipeline Guide
- Jenkins Style: Jenkins / Groovy
- Performance: CI/CD Performance Optimization
- Workflow Templates: GitHub Actions Workflow Templates
- Reusable Workflows: Reusable Workflows Template
- Workflow Example: GitHub Actions Example
- See also: Testing, Automation, Pre-commit Hooks
Cloud Providers¶
- Azure: Microsoft Azure
- GCP: Google Cloud Platform
- See also: AWS, Infrastructure as Code
Code Quality¶
- Anti-Patterns: Common Anti-Patterns
- Code Smells: Code Smell Catalog
- Refactoring: Refactoring Overview
- AI Code Review: AI Code Review
- See also: Linting, Testing
Code Signing¶
- Guide: Code Signing Guide
- See also: Security, CI/CD
Compliance¶
- Compliance as Code: InSpec, OPA & Sentinel
- IaC Testing: IaC Testing Standards
- See also: Security, Testing
Configuration Management¶
- Ansible: Ansible Style Guide
- Environment Config: Environment Configuration
- See also: Infrastructure as Code, YAML
Containers¶
- Dockerfile: Dockerfile Style Guide
- Docker Compose: Docker Compose Style Guide
- Dev Containers: Dev Containers
- Dockerfile Template: Dockerfile Template
- Docker Compose Template: Docker Compose Template
- Container Usage: Container Usage Guide
- See also: Kubernetes
Crossplane¶
- Style Guide: Crossplane
- See also: Kubernetes, Infrastructure as Code
D¶
Data Formats¶
- YAML: YAML Style Guide
- JSON: JSON Style Guide
- JSON Schema: JSON Schema Style Guide
- TOML & INI: TOML & INI Style Guide
- See also: Configuration Management
Decision Trees¶
- Guide: Decision Trees
- See also: Getting Started
Dependencies¶
- Update Policies: Dependency Update Policies
- Dependabot: Dependabot Auto-Merge
- See also: CI/CD, Security
Deployment¶
- Environment Config: Environment Configuration
- Smoke Tests: Smoke Test Standards
- GitOps: GitOps (ArgoCD & Flux)
- See also: CI/CD, Containers
Diagrams¶
- Diagram as Code: Diagram as Code
- See also: Documentation
Documentation¶
- MkDocs Site Example: MkDocs Site Example
- Versioning: Documentation Versioning
- Heading Structure: Heading Structure
- Code Block Tags: Code Block Language Tags
- README Template: README Template
- See also: Metadata, Templates
E¶
Environment Configuration¶
- Guide: Environment Configuration
- Seed Data: Seed Data Management
- See also: Deployment, Security
F¶
Formatting¶
- Python (Black): Python Style Guide
- JavaScript/TypeScript (Prettier): TypeScript Style Guide
- Terraform (terraform fmt): Terraform Style Guide
- IDE Settings: IDE Settings Template
- See also: Linting, Pre-commit Hooks
G¶
Getting Started¶
- Quickstart: Getting Started
- Tutorials: Tutorial Overview
- Python Project Tutorial: Zero to Validated Python Project
- Team Onboarding: Team Onboarding Tutorial
- See also: Decision Trees, Maturity Model
Git Hooks¶
- Git Hooks Library: Git Hooks Library
- Pre-commit Guide: Pre-commit Hooks Guide
- Pre-commit Template: Pre-commit Config Template
- See also: Pre-commit Hooks, CI/CD
GitOps¶
- Style Guide: GitOps (ArgoCD & Flux)
- See also: Kubernetes, CI/CD
Go¶
- Style Guide: Go
- See also: Testing, Formatting
Governance¶
- Guide: Governance
- Principles: Principles
- See also: Getting Started
Groovy¶
- Jenkins/Groovy: Jenkins / Groovy
- Shared Libraries: Jenkins Shared Libraries
- See also: CI/CD
H¶
HCL¶
- Style Guide: HCL
- See also: Terraform, Terragrunt
Helm¶
- Style Guide: Kubernetes & Helm
- Chart Template: Helm Chart Template
- See also: Kubernetes, Containers
I¶
IDE Integration¶
- IDE Integration Guide: IDE Integration Guide
- IDE Settings Template: IDE Settings Template
- Debug Configurations: Debug Configuration Template
- See also: Formatting, Linting
Infrastructure as Code¶
- Terraform: Terraform & Terragrunt
- Terragrunt: Terragrunt (live)
- CloudFormation: AWS CloudFormation
- Bicep: Azure Bicep
- AWS CDK: AWS CDK
- Pulumi: Pulumi
- Crossplane: Crossplane
- IaC Testing: IaC Testing Standards
- Contract Template: CONTRACT.md Template
- Comparison: Language Comparison Matrix
- See also: Terraform, Configuration Management
Interoperability¶
- Cross-Language Guide: Language Interoperability
- See also: Data Formats
J¶
Jenkins¶
- Pipeline Guide: Jenkins Pipeline Guide
- Groovy Style: Jenkins / Groovy
- Shared Libraries: Jenkins Shared Libraries
- See also: CI/CD, Groovy
JSON¶
- Style Guide: JSON
- JSON Schema: JSON Schema
- See also: Data Formats, YAML
K¶
Kubernetes¶
- Style Guide: Kubernetes & Helm
- Helm Chart Template: Helm Chart Template
- GitOps: GitOps (ArgoCD & Flux)
- Crossplane: Crossplane
- See also: Containers, Infrastructure as Code
L¶
Linting¶
- Pre-commit Hooks: Pre-commit Hooks Guide
- Local Setup: Local Validation Setup
- IDE Integration: IDE Integration Guide
- See also: Formatting, Code Quality
M¶
Makefile¶
- Style Guide: Makefile
- See also: Build Tools, Automation
Maturity Model¶
- Guide: Maturity Model
- See also: Getting Started, Governance
Metadata¶
- Schema Reference: Metadata Schema Reference
- Glossary (Metadata Tags): Glossary
- See also: Documentation
Migration Guides¶
- From PEP 8: Migrating from PEP 8
- From Google Style: Migrating from Google Style Guide
- From Airbnb Style: Migrating from Airbnb Style Guide
- Terraform Tutorial: Migrating Existing Terraform Module
- See also: Getting Started
Monitoring¶
- Observability Guide: Observability Guide
- See also: Deployment, Testing
N¶
Naming Conventions¶
- Comparison Matrix: Language Comparison Matrix
- Glossary: Glossary (camelCase, snake_case, kebab-case, PascalCase)
- See also: Formatting
O¶
Observability¶
- Guide: Observability Guide
- See also: Deployment, Monitoring
Operations¶
- Operational Templates: Operational Templates
- Chaos Engineering: Chaos Engineering Guide
- See also: Deployment, Monitoring
P¶
Performance¶
- CI/CD Optimization: Performance Optimization
- Performance Testing: Performance Testing Standards
- See also: Testing, CI/CD
PowerShell¶
- Style Guide: PowerShell
- See also: Scripting, Bash
Pre-commit Hooks¶
- Guide: Pre-commit Hooks Guide
- Config Template: Pre-commit Config Template
- Git Hooks Library: Git Hooks Library
- Local Setup: Local Validation Setup
- See also: Linting, Git Hooks
Pulumi¶
- Style Guide: Pulumi
- See also: Infrastructure as Code
Python¶
- Style Guide: Python
- Refactoring Examples: Python Refactoring
- Package Template: Python Package Template
- Package Example: Python Package Example
- Flask API Example: Flask API Example
- Tutorial: Zero to Validated Python Project
- Migration from PEP 8: From PEP 8
- See also: Testing, Formatting
R¶
Refactoring¶
- Overview: Refactoring Overview
- Python: Python Refactoring
- TypeScript: TypeScript Refactoring
- Terraform: Terraform Refactoring
- Ansible: Ansible Refactoring
- Bash: Bash Refactoring
- See also: Anti-Patterns, Code Quality
REPL¶
- Guide: REPL & Interactive Shells
- See also: Bash, Python
S¶
Scripting¶
- Bash: Bash Style Guide
- PowerShell: PowerShell Style Guide
- Shell Aliases: Shell Aliases & Functions
- See also: Automation
Security¶
- Security Scanning: Security Scanning Guide
- Code Signing: Code Signing Guide
- Compliance as Code: InSpec, OPA & Sentinel
- Dependency Updates: Dependency Update Policies
- See also: Compliance, CI/CD
ShellCheck¶
- Bash Style Guide: Bash
- Pre-commit Hooks: Pre-commit Hooks Guide
- See also: Linting, Scripting
SQL¶
- Style Guide: SQL
- See also: Data Formats
T¶
Task Runners¶
- Task & Just: Task Runners
- Makefile: Makefile
- See also: Build Tools
Templates¶
- README: README Template
- Terraform Module: Terraform Module Template
- Python Package: Python Package Template
- Dockerfile: Dockerfile Template
- Docker Compose: Docker Compose Template
- Helm Chart: Helm Chart Template
- GitHub Actions: GitHub Actions Workflow Templates
- CONTRACT.md: Contract Template
- Testing Docs: Testing Documentation Template
- IDE Settings: IDE Settings Template
- ADR: ADR Template
- Operational: Operational Templates
- Code Generators: Code Generators Template
- See also: Documentation
Terraform¶
- Style Guide: Terraform & Terragrunt
- Refactoring Examples: Terraform Refactoring
- Module Template: Terraform Module Template
- Module Example: Terraform Module Example
- Migration Tutorial: Migrating Existing Terraform Module
- IaC Testing: IaC Testing Standards
- Contract Template: CONTRACT.md Template
- See also: Terragrunt, HCL, Infrastructure as Code
Terragrunt¶
- Style Guide: Terragrunt (live)
- See also: Terraform, HCL
Testing¶
- Testing Strategies: Testing Strategies
- Smoke Tests: Smoke Test Standards
- Performance Testing: Performance Testing Standards
- Chaos Engineering: Chaos Engineering Guide
- IaC Testing: IaC Testing Standards
- Seed Data: Seed Data Management
- Testing Docs Template: Testing Documentation Template
- See also: CI/CD, Code Quality
Tutorials¶
- Overview: Tutorial Overview
- Python Project: Zero to Validated Python Project
- Terraform Migration: Migrating Existing Terraform Module
- Full-Stack App: Full-Stack App with Multiple Languages
- Team Onboarding: Team Onboarding
- Manual to Automated: From Manual to Automated
- See also: Getting Started
TypeScript¶
- Style Guide: TypeScript
- Refactoring Examples: TypeScript Refactoring
- Library Example: TypeScript Library Example
- React App Example: React App Example
- Migration from Airbnb: From Airbnb Style Guide
- See also: JSON, Formatting
V¶
Validation¶
- Local Setup: Local Validation Setup
- AI Validation Pipeline: AI Validation Pipeline
- Container Validation: Container Usage
- See also: Linting, CI/CD
Y¶
YAML¶
- Style Guide: YAML
- See also: Data Formats, Ansible, Kubernetes