docs(P21): rewrite README + normalize modules terminology (REQ-52,55,56,57,58,59,60)
---ci--- project: acdl phase: 21 milestone: v1.6 status: execute ---/ci--- README.md rewrite: - Remove all .ciagent/ references (links + repository-layout row). - Remove .gitea/workflows/ row from repository layout. - Restate repository roles: consumer repo = app code + 1+ contracts + CI definitions (thin .github/workflows/*.yml uses:-ing the central workflow); platform repo owns modules/adapters/core/schemas/pipelines/ scripts/workflows. - Replace Status section with Features list (consumer + platform-engineer referenceable) + Roadmap (planned only, no version changelog, no internal CIAgent status). Includes the composition-redesign roadmap entry (dynamic module creation from a contract). - Fix the mermaid flowchart: all node text visible (short multi-line labels via <br/>), add a security-checks stage before policy checks, do not name specific tools (security checks/policy checks/infrastructure plan via adapter), add infrastructure-apply stage (dev only, after evidence event). - Remove the environments table (dev/qa/prod/dr) completely; point to docs/environments/ for platform-managed environments. - Credentials section: remove go-gitea/gitea#36988 blocked mention + waivers D-039/D-047 language. State OIDC+ABAC default; alternative is a static AWS key (GitHub Secrets for platform-runner runs, .env.secrets locally) with daily rotation (platform-managed) or out-of-band rotation (consumer-managed for local .env.secrets). - forge -> platform runners / platform-managed throughout. - Links point to docs/ Pages paths, not .ciagent/. modules/ terminology: - modules/README.md: L1 primitives -> primitives, L2 compositions -> modules, composition -> pattern (prose); add roadmap note for the composition redesign. - README-TEMPLATE.md: L1 primitive -> primitive. - All 7 L1 READMEs: L1 primitive -> primitive. - L2 static-asset + microservice READMEs: L2 composition -> module pattern, composition -> pattern, L1 -> primitive; bump stale @v1 -> @v1.4 in usage examples; fix CONSUMER_GUIDE.md -> consumer-guide.md link. Verification: grep sweeps for .ciagent/.gitea/forge/go-gitea/waiver/ D-039/D-047/acdl_platform in docs/ README.md modules/ contracts/ all return 0 hits. Tests: 166 pass. run_ci.sh green.
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
# alb — Application Load Balancer (load balancer + target group + listener)
|
||||
|
||||
> **Module kind:** L1 primitive | **Version:** 1.0.0
|
||||
> **Module kind:** primitive | **Version:** 1.0.0
|
||||
|
||||
An Application Load Balancer with a target group and a listener. This is
|
||||
a multi-resource module: it creates a load balancer, a target group, and
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# ecr — ECR repository
|
||||
|
||||
> **Module kind:** L1 primitive | **Version:** 1.0.0
|
||||
> **Module kind:** primitive | **Version:** 1.0.0
|
||||
|
||||
A single ECR repository that hosts the container image for the ECS
|
||||
task. The simplest container-registry module — one resource, two
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# ecs-cluster — ECS Fargate cluster
|
||||
|
||||
> **Module kind:** L1 primitive | **Version:** 1.0.0
|
||||
> **Module kind:** primitive | **Version:** 1.0.0
|
||||
|
||||
An ECS Fargate cluster. The simplest ECS module — one resource, two
|
||||
inputs, two outputs. The cluster is the container orchestration
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# ecs-service — ECS Fargate service (task definition + service)
|
||||
|
||||
> **Module kind:** L1 primitive | **Version:** 1.0.0
|
||||
> **Module kind:** primitive | **Version:** 1.0.0
|
||||
|
||||
An ECS Fargate service with its task definition. Runs a container image
|
||||
on Fargate, optionally behind an ALB target group. This is a
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# iam-role — IAM role
|
||||
|
||||
> **Module kind:** L1 primitive | **Version:** 1.0.0
|
||||
> **Module kind:** primitive | **Version:** 1.0.0
|
||||
|
||||
A single IAM role with an assume-role policy and optional managed
|
||||
policy attachments. Used as the ECS task execution role.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# s3 — S3 bucket
|
||||
|
||||
> **Module kind:** L1 primitive | **Version:** 1.0.0
|
||||
> **Module kind:** primitive | **Version:** 1.0.0
|
||||
|
||||
A single S3 bucket for object storage. The simplest module — one
|
||||
resource, two inputs, two outputs. Versioning is enabled by default.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# vpc — VPC with subnets and routing
|
||||
|
||||
> **Module kind:** L1 primitive | **Version:** 1.0.0
|
||||
> **Module kind:** primitive | **Version:** 1.0.0
|
||||
|
||||
A VPC with one subnet per availability zone and a route table with a
|
||||
default route through an internet gateway. The networking foundation
|
||||
|
||||
Reference in New Issue
Block a user