Skip to content

Architecture Documentation

This directory contains reference documentation about the cluster-gitops repository structure, design decisions, and architectural patterns.

Documents in This Directory

Active Reference Documentation

  1. gitops-structure.md - Reference
  2. GitOps repository structure and organization
  3. Status: Approved
  4. Created: 2025-01-12

  5. structural-changes-summary.md - Technical

  6. Summary of structural changes made 2025-11-16
  7. Status: Approved
  8. Created: 2025-11-16

  9. documentation-update-2025-11-16.md - Reference

  10. Tracking document for documentation consistency updates
  11. Status: Approved
  12. Created: 2025-11-16

Completed Analysis

  1. cluster-gitops-critique.md - Reference
  2. Comprehensive architectural critique of cluster-gitops structure
  3. Status: Completed (issues addressed)
  4. Created: 2025-11-15, Updated: 2025-11-16

Document Types

Following the SyRF Documentation Framework:

  • Reference (doc-type: Reference) - Evergreen system documentation
  • Technical (doc-type: Technical) - Detailed implementation plans and summaries
  • Decision Records: See /docs/decisions/ for ADRs
  • How-To Guides: See /docs/how-to/ for operational guides
  • Deployment Guides: See /docs/deploying-services.md and /docs/promotion-workflow.md

Last Updated: 2025-11-16