docs: add architecture diagram (#140)

crenshaw-dev · web-flow · commit e1e5090f4e0d · 2024-12-03T09:47:42.000-06:00
Signed-off-by: Michael Crenshaw &lt;350466+crenshaw-dev@users.noreply.github.com&gt;
diff --git a/docs/architecture.md b/docs/architecture.md
@@ -0,0 +1,14 @@
+# Architecture
+
+GitOps Promoter enables developers to "make a change and forget it." The change is made once in the "DRY branch" for all
+environments, then GitOps Promoter does the work of moving the change through the environment-specific "hydrated 
+branches."
+
+This diagram shows a hypothetical setup where the "hydrator" is Helm, and the tool syncing the promoted changes is Argo
+CD.
+
+Commit `3f7e` is the user's "DRY" change that applied to all environments. The SHAs of the hydrated commits are
+represented as `3f7e` with an environment-specific subscript. But in reality, the hydrated commits are different SHAs
+since they are on different branches and represent environment-specific contents.
+
+[![GitOps Promoter Architecture](./assets/architecture.png)](./assets/architecture.png)
diff --git a/docs/assets/architecture.png b/docs/assets/architecture.png
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -25,3 +25,4 @@ nav:
   - CRD Specs: crd-specs.md
   - Gating Promotions: gating-promotions.md
   - Multi-Tenancy: multi-tenancy.md
+  - Architecture: architecture.md
