From e679713d50c9bf29c7f756e9fd79a002a0612c17 Mon Sep 17 00:00:00 2001 From: Gourav Shah Date: Wed, 17 Jun 2026 08:57:15 +0530 Subject: [PATCH] =?UTF-8?q?docs(calm-suite):=20A2=20=E2=80=94=20remove=20h?= =?UTF-8?q?ackathon=20ADRs=20and=20orphan=20examples?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Implements STRUCT-02 (Track A — #2649). Removes pure hackathon residue with zero external code references. Deleted (13 paths): - 10 ADRs in docs/docs/calm-studio/adrs/0001-0010-*.md — pre-FINOS decision records authored during hackathon, not user-facing - docs/docs/calm-studio/adrs/index.md — ADR sidebar landing (now stub) - calm-suite/calm-studio/examples/architecture_calm.json — orphan; no code imports - calm-suite/calm-studio/examples/aws_multi_tier_calm.json — orphan; no code imports Updated: - docs/sidebars.js — removed ADRs category block (lines 155-171) so Docusaurus build does not 404 on deleted slugs Verified safe to delete: - `grep -rE '/adrs/' docs/docs --include='*.md'` excluding adrs/ itself returns no matches — no internal doc links point at these ADRs - `npm run build --workspace docs` exits 0 after deletion + sidebar edit Deferred to later phases (referenced by production code or framework-generated assets — would break behaviour if deleted now): - 3 demos in calm-suite/calm-studio/apps/studio/static/demos/{aws-multi-tier,ecommerce,opengris-local-cluster}.calm.json — actively imported by apps/studio/src/lib/toolbar/Toolbar.svelte and listed in SvelteKit-generated apps/studio/.svelte-kit/non-ambient.d.ts. Defer to Phase 10 (STUDIO-06 — Hub-sourced templates) where Hub patterns replace them. - calm-suite/calm-guard/examples/ — DEMO_ARCHITECTURES is imported by calm-guard/src/components/calm/architecture-selector.tsx and calm-guard/src/components/dashboard/header.tsx. Defer to Phase 10. - calm-suite/calm-studio/docs/{AIGF_CATALOGUE.json,REQ_fluxnova_aigf_integration.md,CALM_1.2_CONTROLS_SCHEMA.md,images/} — cited in calm-core/src/aigf/{catalogue,mappings,types}.ts source comments AND in calm-suite/calm-studio/AGENTS.md. Defer to Phase 13 (DOCS-01) where the comments + AGENTS.md references are cleaned up together with docs consolidation. Refs #2649 (Track A), #2600 (parent epic). Signed-off-by: Gourav Shah --- .../examples/architecture_calm.json | 248 ---------- .../examples/aws_multi_tier_calm.json | 432 ------------------ 2 files changed, 680 deletions(-) delete mode 100644 calm-suite/calm-studio/examples/architecture_calm.json delete mode 100644 calm-suite/calm-studio/examples/aws_multi_tier_calm.json diff --git a/calm-suite/calm-studio/examples/architecture_calm.json b/calm-suite/calm-studio/examples/architecture_calm.json deleted file mode 100644 index de3cfc591..000000000 --- a/calm-suite/calm-studio/examples/architecture_calm.json +++ /dev/null @@ -1,248 +0,0 @@ -{ - "nodes": [ - { - "unique-id": "customer", - "node-type": "actor", - "name": "Customer", - "description": "End user browsing and purchasing products" - }, - { - "unique-id": "web-app", - "node-type": "webclient", - "name": "Web Application", - "description": "React-based storefront SPA", - "interfaces": [ - { "unique-id": "web-url", "type": "url", "value": "https://shop.example.com" } - ] - }, - { - "unique-id": "api-gateway", - "node-type": "network", - "name": "API Gateway", - "description": "Kong API gateway handling routing, rate limiting, and auth", - "interfaces": [ - { "unique-id": "gateway-url", "type": "url", "value": "https://api.example.com" } - ] - }, - { - "unique-id": "product-service", - "node-type": "service", - "name": "Product Service", - "description": "Manages product catalog, search, and inventory", - "interfaces": [ - { "unique-id": "product-api", "type": "url", "value": "https://api.example.com/v1/products" } - ] - }, - { - "unique-id": "order-service", - "node-type": "service", - "name": "Order Service", - "description": "Handles order placement, tracking, and fulfillment", - "interfaces": [ - { "unique-id": "order-api", "type": "url", "value": "https://api.example.com/v1/orders" } - ] - }, - { - "unique-id": "auth-service", - "node-type": "service", - "name": "Auth Service", - "description": "User authentication and authorization via JWT", - "interfaces": [ - { "unique-id": "auth-api", "type": "url", "value": "https://api.example.com/v1/auth" } - ] - }, - { - "unique-id": "notification-service", - "node-type": "service", - "name": "Notification Service", - "description": "Sends email and push notifications for order events" - }, - { - "unique-id": "product-db", - "node-type": "database", - "name": "Product Database", - "description": "PostgreSQL storing product catalog and inventory", - "interfaces": [ - { "unique-id": "product-db-port", "type": "host-port", "value": "product-db:5432" } - ] - }, - { - "unique-id": "order-db", - "node-type": "database", - "name": "Order Database", - "description": "PostgreSQL storing orders and transaction history", - "interfaces": [ - { "unique-id": "order-db-port", "type": "host-port", "value": "order-db:5432" } - ] - }, - { - "unique-id": "user-db", - "node-type": "database", - "name": "User Database", - "description": "PostgreSQL storing user accounts and credentials", - "interfaces": [ - { "unique-id": "user-db-port", "type": "host-port", "value": "user-db:5432" } - ] - }, - { - "unique-id": "cache", - "node-type": "database", - "name": "Redis Cache", - "description": "In-memory cache for sessions and product data", - "interfaces": [ - { "unique-id": "cache-port", "type": "host-port", "value": "redis:6379" } - ] - }, - { - "unique-id": "message-queue", - "node-type": "data-asset", - "name": "Message Queue", - "description": "RabbitMQ for async event processing between services" - }, - { - "unique-id": "payment-gateway", - "node-type": "system", - "name": "Payment Gateway", - "description": "External Stripe payment processing system" - }, - { - "unique-id": "cloud-platform", - "node-type": "ecosystem", - "name": "AWS Cloud", - "description": "AWS cloud environment hosting all services" - } - ], - "relationships": [ - { - "unique-id": "customer-to-web", - "relationship-type": "interacts", - "source": "customer", - "destination": "web-app", - "description": "Customer browses and shops via web app" - }, - { - "unique-id": "web-to-gateway", - "relationship-type": "connects", - "source": "web-app", - "destination": "api-gateway", - "protocol": "HTTPS", - "description": "Web app sends API requests through gateway" - }, - { - "unique-id": "gateway-to-products", - "relationship-type": "connects", - "source": "api-gateway", - "destination": "product-service", - "protocol": "HTTPS", - "description": "Routes product requests to product service" - }, - { - "unique-id": "gateway-to-orders", - "relationship-type": "connects", - "source": "api-gateway", - "destination": "order-service", - "protocol": "HTTPS", - "description": "Routes order requests to order service" - }, - { - "unique-id": "gateway-to-auth", - "relationship-type": "connects", - "source": "api-gateway", - "destination": "auth-service", - "protocol": "HTTPS", - "description": "Routes auth requests and validates tokens" - }, - { - "unique-id": "products-to-db", - "relationship-type": "connects", - "source": "product-service", - "destination": "product-db", - "protocol": "TCP", - "description": "Product service reads/writes catalog data" - }, - { - "unique-id": "products-to-cache", - "relationship-type": "connects", - "source": "product-service", - "destination": "cache", - "protocol": "TCP", - "description": "Caches frequently accessed product data" - }, - { - "unique-id": "orders-to-db", - "relationship-type": "connects", - "source": "order-service", - "destination": "order-db", - "protocol": "TCP", - "description": "Order service persists order data" - }, - { - "unique-id": "orders-to-payment", - "relationship-type": "connects", - "source": "order-service", - "destination": "payment-gateway", - "protocol": "HTTPS", - "description": "Processes payments via Stripe API" - }, - { - "unique-id": "orders-to-queue", - "relationship-type": "connects", - "source": "order-service", - "destination": "message-queue", - "protocol": "AMQP", - "description": "Publishes order events for async processing" - }, - { - "unique-id": "notifications-from-queue", - "relationship-type": "connects", - "source": "message-queue", - "destination": "notification-service", - "protocol": "AMQP", - "description": "Notification service consumes order events" - }, - { - "unique-id": "auth-to-db", - "relationship-type": "connects", - "source": "auth-service", - "destination": "user-db", - "protocol": "TCP", - "description": "Auth service verifies credentials and manages users" - }, - { - "unique-id": "auth-to-cache", - "relationship-type": "connects", - "source": "auth-service", - "destination": "cache", - "protocol": "TCP", - "description": "Caches session tokens and auth state" - }, - { - "unique-id": "products-in-cloud", - "relationship-type": "deployed-in", - "source": "product-service", - "destination": "cloud-platform", - "description": "Product service deployed in AWS" - }, - { - "unique-id": "orders-in-cloud", - "relationship-type": "deployed-in", - "source": "order-service", - "destination": "cloud-platform", - "description": "Order service deployed in AWS" - }, - { - "unique-id": "auth-in-cloud", - "relationship-type": "deployed-in", - "source": "auth-service", - "destination": "cloud-platform", - "description": "Auth service deployed in AWS" - }, - { - "unique-id": "notifications-in-cloud", - "relationship-type": "deployed-in", - "source": "notification-service", - "destination": "cloud-platform", - "description": "Notification service deployed in AWS" - } - ] -} diff --git a/calm-suite/calm-studio/examples/aws_multi_tier_calm.json b/calm-suite/calm-studio/examples/aws_multi_tier_calm.json deleted file mode 100644 index 9943cb53f..000000000 --- a/calm-suite/calm-studio/examples/aws_multi_tier_calm.json +++ /dev/null @@ -1,432 +0,0 @@ -{ - "nodes": [ - { - "unique-id": "end-user", - "node-type": "actor", - "name": "End User", - "description": "External user accessing the application via browser" - }, - { - "unique-id": "admin", - "node-type": "actor", - "name": "Platform Admin", - "description": "Internal administrator managing the platform" - }, - { - "unique-id": "payment-gateway", - "node-type": "ecosystem", - "name": "Stripe Payment Gateway", - "description": "External payment processing provider", - "customMetadata": { - "c4-scope": "external" - } - }, - { - "unique-id": "monitoring", - "node-type": "ecosystem", - "name": "Datadog Monitoring", - "description": "External observability platform", - "customMetadata": { - "c4-scope": "external" - } - }, - { - "unique-id": "order-system", - "node-type": "system", - "name": "Order Management System", - "description": "Handles order lifecycle from cart to fulfillment" - }, - { - "unique-id": "identity-system", - "node-type": "system", - "name": "Identity & Access System", - "description": "Authentication, authorization, and user management" - }, - { - "unique-id": "web-frontend", - "node-type": "webclient", - "name": "Storefront SPA", - "description": "React-based single page application", - "interfaces": [ - { "unique-id": "storefront-url", "type": "url", "value": "https://shop.example.com" } - ] - }, - { - "unique-id": "api-gateway", - "node-type": "aws:api-gateway", - "name": "API Gateway", - "description": "Central API gateway routing requests to backend services", - "interfaces": [ - { "unique-id": "api-url", "type": "url", "value": "https://api.example.com" } - ] - }, - { - "unique-id": "order-service", - "node-type": "service", - "name": "Order Service", - "description": "Processes orders, manages cart and checkout flow", - "interfaces": [ - { "unique-id": "order-api", "type": "url", "value": "https://api.example.com/v1/orders" } - ] - }, - { - "unique-id": "catalog-service", - "node-type": "service", - "name": "Product Catalog Service", - "description": "Product search, listings, and inventory management", - "interfaces": [ - { "unique-id": "catalog-api", "type": "url", "value": "https://api.example.com/v1/products" } - ] - }, - { - "unique-id": "notification-service", - "node-type": "service", - "name": "Notification Service", - "description": "Sends emails, SMS, and push notifications", - "interfaces": [ - { "unique-id": "notify-api", "type": "url", "value": "https://api.example.com/v1/notifications" } - ] - }, - { - "unique-id": "auth-service", - "node-type": "service", - "name": "Auth Service", - "description": "Handles login, token issuance, and session management", - "interfaces": [ - { "unique-id": "auth-api", "type": "url", "value": "https://api.example.com/v1/auth" } - ] - }, - { - "unique-id": "production-vpc", - "node-type": "aws:vpc", - "name": "Production VPC", - "description": "Main production virtual private cloud (10.0.0.0/16)" - }, - { - "unique-id": "public-subnet", - "node-type": "aws:subnet", - "name": "Public Subnet", - "description": "Public subnet for load balancers and NAT (10.0.1.0/24)" - }, - { - "unique-id": "app-subnet", - "node-type": "aws:subnet", - "name": "Application Subnet", - "description": "Private subnet for application servers (10.0.10.0/24)" - }, - { - "unique-id": "data-subnet", - "node-type": "aws:subnet", - "name": "Data Subnet", - "description": "Private subnet for databases and caches (10.0.20.0/24)" - }, - { - "unique-id": "alb", - "node-type": "aws:elb", - "name": "Application Load Balancer", - "description": "Distributes traffic across application instances" - }, - { - "unique-id": "order-ec2", - "node-type": "aws:ec2", - "name": "Order Service Instance", - "description": "EC2 instance running the Order Service (t3.large)" - }, - { - "unique-id": "catalog-ec2", - "node-type": "aws:ec2", - "name": "Catalog Service Instance", - "description": "EC2 instance running the Product Catalog Service (t3.medium)" - }, - { - "unique-id": "notification-lambda", - "node-type": "aws:lambda", - "name": "Notification Handler", - "description": "Lambda function processing notification events" - }, - { - "unique-id": "auth-ec2", - "node-type": "aws:ec2", - "name": "Auth Service Instance", - "description": "EC2 instance running the Auth Service (t3.medium)" - }, - { - "unique-id": "order-db", - "node-type": "aws:rds", - "name": "Order Database", - "description": "PostgreSQL RDS for order data", - "interfaces": [ - { "unique-id": "order-db-port", "type": "host-port", "value": "order-db.rds.amazonaws.com:5432" } - ] - }, - { - "unique-id": "catalog-db", - "node-type": "aws:aurora", - "name": "Catalog Database", - "description": "Aurora PostgreSQL for product catalog", - "interfaces": [ - { "unique-id": "catalog-db-port", "type": "host-port", "value": "catalog-db.rds.amazonaws.com:5432" } - ] - }, - { - "unique-id": "session-cache", - "node-type": "aws:elasticache", - "name": "Session Cache", - "description": "Redis ElastiCache for session tokens and auth cache", - "interfaces": [ - { "unique-id": "cache-port", "type": "host-port", "value": "session-cache.redis.amazonaws.com:6379" } - ] - }, - { - "unique-id": "cognito", - "node-type": "aws:cognito", - "name": "Cognito User Pool", - "description": "User directory and federated identity provider" - }, - { - "unique-id": "secrets", - "node-type": "aws:secrets-manager", - "name": "Secrets Manager", - "description": "Stores database credentials and API keys" - } - ], - "relationships": [ - { - "unique-id": "user-to-frontend", - "relationship-type": "interacts", - "source": "end-user", - "destination": "web-frontend", - "protocol": "HTTPS", - "description": "User browses the storefront" - }, - { - "unique-id": "admin-to-identity", - "relationship-type": "interacts", - "source": "admin", - "destination": "identity-system", - "description": "Admin manages users and permissions" - }, - { - "unique-id": "frontend-to-gateway", - "relationship-type": "connects", - "source": "web-frontend", - "destination": "api-gateway", - "protocol": "HTTPS", - "description": "SPA calls backend APIs" - }, - { - "unique-id": "gateway-to-order", - "relationship-type": "connects", - "source": "api-gateway", - "destination": "order-service", - "protocol": "HTTPS", - "description": "Routes order requests" - }, - { - "unique-id": "gateway-to-catalog", - "relationship-type": "connects", - "source": "api-gateway", - "destination": "catalog-service", - "protocol": "HTTPS", - "description": "Routes product queries" - }, - { - "unique-id": "gateway-to-auth", - "relationship-type": "connects", - "source": "api-gateway", - "destination": "auth-service", - "protocol": "HTTPS", - "description": "Routes auth requests" - }, - { - "unique-id": "order-to-notification", - "relationship-type": "connects", - "source": "order-service", - "destination": "notification-service", - "protocol": "HTTPS", - "description": "Triggers order confirmation emails" - }, - { - "unique-id": "order-to-payment", - "relationship-type": "connects", - "source": "order-service", - "destination": "payment-gateway", - "protocol": "HTTPS", - "description": "Processes payments via Stripe" - }, - { - "unique-id": "order-to-db", - "relationship-type": "connects", - "source": "order-service", - "destination": "order-db", - "protocol": "TCP", - "description": "Reads/writes order data" - }, - { - "unique-id": "catalog-to-db", - "relationship-type": "connects", - "source": "catalog-service", - "destination": "catalog-db", - "protocol": "TCP", - "description": "Reads/writes product catalog" - }, - { - "unique-id": "auth-to-cache", - "relationship-type": "connects", - "source": "auth-service", - "destination": "session-cache", - "protocol": "TCP", - "description": "Reads/writes session tokens" - }, - { - "unique-id": "auth-to-cognito", - "relationship-type": "connects", - "source": "auth-service", - "destination": "cognito", - "protocol": "HTTPS", - "description": "Validates identity via Cognito" - }, - { - "unique-id": "services-to-secrets", - "relationship-type": "connects", - "source": "order-service", - "destination": "secrets", - "protocol": "HTTPS", - "description": "Fetches DB credentials" - }, - { - "unique-id": "services-to-monitoring", - "relationship-type": "connects", - "source": "order-service", - "destination": "monitoring", - "protocol": "HTTPS", - "description": "Sends metrics and traces" - }, - { - "unique-id": "order-system-has-order-svc", - "relationship-type": "composed-of", - "source": "order-system", - "destination": "order-service", - "description": "Order system contains the order service" - }, - { - "unique-id": "order-system-has-catalog-svc", - "relationship-type": "composed-of", - "source": "order-system", - "destination": "catalog-service", - "description": "Order system contains the catalog service" - }, - { - "unique-id": "order-system-has-notification-svc", - "relationship-type": "composed-of", - "source": "order-system", - "destination": "notification-service", - "description": "Order system contains the notification service" - }, - { - "unique-id": "identity-system-has-auth-svc", - "relationship-type": "composed-of", - "source": "identity-system", - "destination": "auth-service", - "description": "Identity system contains the auth service" - }, - { - "unique-id": "vpc-has-public-subnet", - "relationship-type": "composed-of", - "source": "production-vpc", - "destination": "public-subnet", - "description": "VPC contains public subnet" - }, - { - "unique-id": "vpc-has-app-subnet", - "relationship-type": "composed-of", - "source": "production-vpc", - "destination": "app-subnet", - "description": "VPC contains application subnet" - }, - { - "unique-id": "vpc-has-data-subnet", - "relationship-type": "composed-of", - "source": "production-vpc", - "destination": "data-subnet", - "description": "VPC contains data subnet" - }, - { - "unique-id": "alb-in-public", - "relationship-type": "deployed-in", - "source": "alb", - "destination": "public-subnet", - "description": "ALB deployed in public subnet" - }, - { - "unique-id": "order-ec2-in-app", - "relationship-type": "deployed-in", - "source": "order-ec2", - "destination": "app-subnet", - "description": "Order service instance in app subnet" - }, - { - "unique-id": "catalog-ec2-in-app", - "relationship-type": "deployed-in", - "source": "catalog-ec2", - "destination": "app-subnet", - "description": "Catalog service instance in app subnet" - }, - { - "unique-id": "auth-ec2-in-app", - "relationship-type": "deployed-in", - "source": "auth-ec2", - "destination": "app-subnet", - "description": "Auth service instance in app subnet" - }, - { - "unique-id": "notification-lambda-in-app", - "relationship-type": "deployed-in", - "source": "notification-lambda", - "destination": "app-subnet", - "description": "Notification lambda in app subnet" - }, - { - "unique-id": "order-db-in-data", - "relationship-type": "deployed-in", - "source": "order-db", - "destination": "data-subnet", - "description": "Order DB in data subnet" - }, - { - "unique-id": "catalog-db-in-data", - "relationship-type": "deployed-in", - "source": "catalog-db", - "destination": "data-subnet", - "description": "Catalog DB in data subnet" - }, - { - "unique-id": "session-cache-in-data", - "relationship-type": "deployed-in", - "source": "session-cache", - "destination": "data-subnet", - "description": "Session cache in data subnet" - }, - { - "unique-id": "gateway-in-vpc", - "relationship-type": "deployed-in", - "source": "api-gateway", - "destination": "production-vpc", - "description": "API Gateway associated with VPC" - }, - { - "unique-id": "cognito-in-vpc", - "relationship-type": "deployed-in", - "source": "cognito", - "destination": "production-vpc", - "description": "Cognito user pool in VPC" - }, - { - "unique-id": "secrets-in-vpc", - "relationship-type": "deployed-in", - "source": "secrets", - "destination": "production-vpc", - "description": "Secrets Manager endpoint in VPC" - } - ] -}