Publish the curated Stack example catalog

.github/workflows/ci.yml

@@ -50,6 +50,11 @@ jobs:
       - name: Validate JSON Schemas
         run: check-jsonschema --check-metaschema schemas/*.json
 
+      - name: Validate example catalog
+        run: |
+          check-jsonschema --schemafile schemas/example-catalog.schema.json examples/catalog.json
+          python scripts/validate-example-catalog.py
+
       - name: Validate normalized IR fixtures
         run: check-jsonschema --schemafile schemas/normalized-ir.schema.json conformance/valid/*/expected.ir.json conformance/formatter/*/expected.ir.json
 

README.md

@@ -64,8 +64,10 @@ Install the development requirements and validate the portable schemas and confo
 ```sh
 python -m pip install --requirement requirements-dev.txt
 check-jsonschema --check-metaschema schemas/*.json
+check-jsonschema --schemafile schemas/example-catalog.schema.json examples/catalog.json
 check-jsonschema --schemafile schemas/normalized-ir.schema.json conformance/valid/*/expected.ir.json conformance/formatter/*/expected.ir.json
 find conformance -name expected.diagnostics.json -print0 | xargs -0 check-jsonschema --schemafile schemas/diagnostic-expectations.schema.json
+python scripts/validate-example-catalog.py
 python scripts/validate-compiler-diagnostics.py
 python scripts/validate-formatter-fixtures.py
 npm ci

examples/02-node-semantics.stack

@@ -5,13 +5,13 @@ diagram "Application and datastore" {
 
   node app "Application" {
     kind service
-    icon "service"
+    icon "server"
     detail "Business logic"
   }
 
   node db "Primary database" {
     kind database
-    icon "postgresql"
+    icon "database"
     detail "PostgreSQL"
   }
 

examples/03-groups-and-layout.stack

@@ -14,7 +14,7 @@ diagram "Public application" {
 
     node browser "Browser" {
       kind client
-      icon "browser"
+      icon "web"
     }
 
     node mobile "Mobile app" {

examples/04-commerce-platform.stack

@@ -12,7 +12,7 @@ diagram "Commerce platform" {
   group storefront "Storefront" {
     node web "Web storefront" {
       kind client
-      icon "nextjs"
+      icon "web"
       detail "Next.js"
     }
 
@@ -54,12 +54,12 @@ diagram "Commerce platform" {
   group data "Data" {
     node products "Product database" {
       kind database
-      icon "postgresql"
+      icon "database"
     }
 
     node orders "Order database" {
       kind database
-      icon "postgresql"
+      icon "database"
     }
 
     node assets "Product media" {

examples/05-aws-serverless.stack

@@ -0,0 +1,76 @@
+stack 1.0
+
+diagram "AWS serverless checkout" {
+  theme light
+
+  layout {
+    direction right
+  }
+
+  node customer "Customer" {
+    kind actor
+  }
+
+  group edge "Edge" {
+    node cdn "CloudFront" {
+      kind service
+      icon "aws:amazon-cloudfront"
+    }
+
+    node gateway "API Gateway" {
+      kind service
+      icon "aws:amazon-api-gateway"
+    }
+  }
+
+  group compute "Serverless compute" {
+    node checkout "Checkout" {
+      kind function
+      icon "aws:lambda"
+    }
+
+    node events "Order events" {
+      kind queue
+      icon "aws:amazon-eventbridge"
+    }
+
+    node fulfillment "Fulfillment" {
+      kind worker
+      icon "aws:lambda"
+    }
+  }
+
+  group data "Data" {
+    node orders "Orders" {
+      kind database
+      icon "aws:dynamodb"
+    }
+
+    node receipts "Receipts" {
+      kind storage
+      icon "aws:s3"
+    }
+  }
+
+  edge customer -> cdn "HTTPS" {
+    kind request
+  }
+  edge cdn -> gateway "API request" {
+    kind request
+  }
+  edge gateway -> checkout "Invoke" {
+    kind request
+  }
+  edge checkout -> orders "Write order" {
+    kind data
+  }
+  edge checkout -> events "OrderPlaced" {
+    kind event
+  }
+  edge events -> fulfillment "Dispatch" {
+    kind event
+  }
+  edge fulfillment -> receipts "Archive" {
+    kind data
+  }
+}

examples/06-gcp-data-service.stack

@@ -0,0 +1,58 @@
+stack 1.0
+
+diagram "GCP data service" {
+  theme light
+
+  layout {
+    direction right
+  }
+
+  node client "Web client" {
+    kind client
+    icon "web"
+  }
+
+  group application "Application" {
+    node api "Cloud Run API" {
+      kind service
+      icon "gcp:cloud-run"
+    }
+
+    node database "Cloud SQL" {
+      kind database
+      icon "gcp:cloud-sql"
+    }
+
+    node objects "Cloud Storage" {
+      kind storage
+      icon "gcp:cloud-storage"
+    }
+  }
+
+  group analytics "Analytics" {
+    node warehouse "BigQuery" {
+      kind database
+      icon "gcp:bigquery"
+    }
+
+    node analyst "Analyst" {
+      kind actor
+    }
+  }
+
+  edge client -> api "HTTPS" {
+    kind request
+  }
+  edge api -> database "SQL" {
+    kind data
+  }
+  edge api -> objects "Uploads" {
+    kind data
+  }
+  edge api -> warehouse "Events" {
+    kind event
+  }
+  edge analyst -> warehouse "Queries" {
+    kind request
+  }
+}

examples/07-azure-event-platform.stack

@@ -0,0 +1,76 @@
+stack 1.0
+
+diagram "Azure event platform" {
+  theme light
+
+  layout {
+    direction right
+  }
+
+  node customer "Customer" {
+    kind actor
+  }
+
+  group delivery "Delivery" {
+    node frontdoor "Front Door" {
+      kind service
+      icon "azure:front-door-and-cdn-profiles"
+    }
+
+    node app "App Service" {
+      kind service
+      icon "azure:app-service"
+    }
+  }
+
+  group processing "Event processing" {
+    node ingest "Ingest function" {
+      kind function
+      icon "azure:function-apps"
+    }
+
+    node bus "Service Bus" {
+      kind queue
+      icon "azure:azure-service-bus"
+    }
+
+    node worker "Background function" {
+      kind worker
+      icon "azure:function-apps"
+    }
+  }
+
+  group data "Data" {
+    node database "Cosmos DB" {
+      kind database
+      icon "azure:azure-cosmos-db"
+    }
+
+    node archive "Storage account" {
+      kind storage
+      icon "azure:storage-accounts"
+    }
+  }
+
+  edge customer -> frontdoor "HTTPS" {
+    kind request
+  }
+  edge frontdoor -> app "Route" {
+    kind request
+  }
+  edge app -> ingest "Submit" {
+    kind request
+  }
+  edge ingest -> bus "Work item" {
+    kind event
+  }
+  edge bus -> worker "Dispatch" {
+    kind event
+  }
+  edge worker -> database "Persist" {
+    kind data
+  }
+  edge worker -> archive "Archive" {
+    kind data
+  }
+}

examples/08-github-delivery.stack

@@ -0,0 +1,50 @@
+stack 1.0
+
+diagram "GitHub delivery workflow" {
+  theme dark
+
+  layout {
+    direction right
+  }
+
+  node developer "Developer" {
+    kind actor
+  }
+
+  group source "Source" {
+    node github "GitHub repository" {
+      kind service
+      icon "simple-icons:github"
+    }
+
+    node actions "GitHub Actions" {
+      kind worker
+      icon "simple-icons:githubactions"
+    }
+  }
+
+  group delivery "Delivery" {
+    node web "Vercel" {
+      kind external
+      icon "simple-icons:vercel"
+    }
+
+    node errors "Sentry" {
+      kind external
+      icon "simple-icons:sentry"
+    }
+  }
+
+  edge developer -> github "Push" {
+    kind data
+  }
+  edge github -> actions "Workflow" {
+    kind event
+  }
+  edge actions -> web "Deploy" {
+    kind dependency
+  }
+  edge web -> errors "Report errors" {
+    kind event
+  }
+}