You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 338b4d0
Browse filesBrowse the repository at this point in the historyBrowse files
`development`, `release`, `governance`, `agent`, `ingestion`) names the corpus
358
+
**surface** a node documents, not the documentation form (explanation, reference,
359
+
how-to) its prose takes. A corpus node instance actually written from this
360
+
template — a real concept document about a real Buzz idea — may take a `type`
361
+
value other than `governance`, decided by that instance's own subject against PRD
362
+
#602's corpus-surface list. This template document itself carries
363
+
`type: governance` because it documents the corpus's own authoring rules, per the
364
+
precedent in the evidence ledger above, not because concept-shaped nodes in
365
+
general use `governance`.
366
+
340
367
## Scope and omissions
341
368
342
369
**This document covers** the purpose of a concept node, the sections it must
343
-
contain, what evidence each section needs, and the industry model it adapts. It
344
-
does not itself explain any real Buzz concept.
370
+
contain (including its own required scope-and-omissions section), what evidence
371
+
each section needs, the industry model it adapts, and what `type` a concept
372
+
instance carries. It does not itself explain any real Buzz concept.
345
373
346
374
**It does not cover, and these are gaps rather than silence:**
347
375
348
376
| Not covered here | Owned by |
349
377
|---|---|
350
378
| The reference document form and its required sections |#1346|
351
379
| The procedure/how-to document form and its required sections |#1345|
380
+
| The glossary-term document form, for a single defined term needing only a short lookup definition |#1340, `glossary-term.md`|
352
381
| The front-matter contract itself |`launchpad/docs/corpus/schema/node.schema.json`|
353
382
| Evidence classification mechanics beyond what this template's own sections need |`launchpad/docs/corpus/AGENTS.md`, `standards/confidence.md`|
354
383
| Whether a diagram-authoring convention (e.g. a fixed Mermaid style) should be standardized corpus-wide | Not yet filed as its own issue at the recorded revision |
Copy file name to clipboardExpand all lines: launchpad/docs/corpus/templates/configuration.md
+15-18Lines changed: 15 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ evidence:
29
29
evidence:
30
30
- "git_show(ref='origin/task/1335-corpus-template-decision-reference', path='launchpad/docs/corpus/templates/decision-reference.md') -> front matter type: governance"
31
31
- "git_show(ref='origin/task/1346-corpus-template-reference', path='launchpad/docs/corpus/templates/reference.md') -> front matter type: governance"
32
-
- statement: "relationships.schema.json defines five relationship types -- depends-on, supersedes, implements, references, part-of -- with references' directionality stated as 'source cites target as supporting context; no ownership or currency dependency implied', generated inverse referenced-by."
32
+
- statement: "relationships.schema.json defines five relationship types -- depends-on, supersedes, implements, references, part-of -- with references' directionality stated as 'source cites target as supporting context; no ownership or currency dependency implied', and an inverse named referenced-by that is authored, not generated -- the only one of the five relationship types whose inverse is authored rather than generated."
- statement: "Parent Feature #605's acceptance criteria require that 'every template states its purpose, required sections, evidence expectations and the industry model/standard it adapts', and this is the acceptance bar this node is built against rather than issue #1332's own copied-over standards-track Definition of Done."
- statement: "Issue #1332's own Definition of Done is byte-identical to the standards-track boilerplate ('States scope and authority/source of the policy. Separates MUST requirements from SHOULD guidance. Defines enforcement/checks and exception/escalation process. Links decisions or higher-order policy instead of duplicating them.'), the same text independently found copied across #1326-#1351."
provided_by: "launchpad-26/buzz#1332 definition of done"
99
97
- statement: "Issue #1332's Objective reads 'Create launchpad/docs/corpus/templates/configuration.md as the single canonical policy node for configuration', and issue #1326's Objective reads 'Create launchpad/docs/corpus/templates/architecture-component.md as the single canonical policy node for architecture component' -- the identical phrase 'policy node' applied to a different template task, confirming the word is boilerplate carried by the planning apparatus rather than a considered classification specific to #1332."
provided_by: "launchpad-26/buzz#1332 Objective, compared against launchpad-26/buzz#1326 Objective"
104
100
- statement: "An unmerged research note cataloguing industry-standard project documentation templates does not mention configuration, config files, environment variables or the Twelve-Factor App anywhere in its text."
105
101
entry_class: TEAM_KNOWLEDGE
106
102
provided_by: "launchpad-26/buzz#1466 (unmerged research note, launchpad/Research/project-documentation-templates.md on branch docs/research-project-doc-templates)"
@@ -158,7 +154,7 @@ review-enforced half.
158
154
| Relationship types and their directionality |`launchpad/docs/corpus/schema/relationships.schema.json`|
159
155
| Creating, updating and retiring a node |`launchpad/docs/corpus/AGENTS.md`|
160
156
| Citing an accepted decision as evidence |`launchpad/docs/corpus/standards/decision-references.md`|
161
-
| The generic reference template this one specializes |`launchpad/docs/corpus/templates/reference.md` (`#1346`, once merged) |
157
+
| The generic reference template this one specializes |`launchpad/docs/corpus/templates/reference.md` (`corpus-template-reference`, #1346) |
162
158
| The industry models this template adapts |*Industry model* below, and the primary sources it cites |
163
159
164
160
If this node and any of those disagree, **they win** -- this one has drifted and
@@ -427,12 +423,13 @@ A node built from this template:
427
423
-**may** declare `part-of` toward a broader capability, deployment, or operations
428
424
node this configuration surface is a subsection of, when the settings are one
429
425
part of a larger documented surface rather than independently standing.
430
-
-**may** declare `references` toward the generic reference template (`#1346`,
431
-
once merged) or toward this template node itself (target:
432
-
`corpus-template-configuration`), if the author wants the generated
433
-
`referenced-by` edge; this is optional, since a node's shape (Configuration
Copy file name to clipboardExpand all lines: launchpad/docs/corpus/templates/deployment.md
+27-7Lines changed: 27 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -90,6 +90,11 @@ evidence:
90
90
entry_class: FACT
91
91
evidence:
92
92
- "docker-compose.yml"
93
+
- statement: "launchpad/ENVIRONMENTS.md is the cohort document that owns the list of environments this repository actually operates, and its table carries four rows -- Local development (status IMPLEMENTED), Local VM harness (status OPEN, tracked by issues #17 and #19), Cohort VPS (status OPEN, tracked by issues #21 and #22), and Contributors' machines (status OPEN, tracked by issue #43) -- none of which is named \"Quickstart\" or \"Production\"; those two names belong to deploy/charts/buzz's own Helm values profiles instead, per deploy/charts/buzz/README.md."
94
+
entry_class: FACT
95
+
evidence:
96
+
- "launchpad/ENVIRONMENTS.md"
97
+
- "deploy/charts/buzz/README.md"
93
98
- statement: "CLAUDE.md's Getting Started section instructs `just relay` to \"start relay at ws://localhost:3000\" as a separate step from `just setup`, consistent with the relay running as a locally built process against docker-compose's containerized Postgres and Redis rather than as a fourth container inside docker-compose.yml itself."
94
99
entry_class: FACT
95
100
evidence:
@@ -216,6 +221,7 @@ the ledger rather than being re-argued here in prose a second time.
216
221
| The boundary this node draws against, primary source |`launchpad-26/buzz#1529` (architecture-container template) |
| This repository's own operated environments — the real list, owned separately from any chart's values profiles |`launchpad/ENVIRONMENTS.md`|
219
225
220
226
If this file and any of those disagree, **they win** — this one has drifted and
221
227
should be fixed.
@@ -427,14 +433,28 @@ topology, which is future work for whoever writes that instance node, not this
427
433
template). The container used below (`buzz-relay`) is the same container issue
428
434
#1327's template established by the same test it uses (a `[[bin]]` target and
429
435
`src/main.rs`); this node reuses that identity rather than re-arguing it, and
430
-
maps how its deployment topology genuinely differs across three environments this
431
-
repository actually defines:
432
-
433
-
| Environment | Source | How `buzz-relay` is deployed |
436
+
maps its deployment topology across a table whose rows are of two different
437
+
kinds: one row is an environment this repository's own `launchpad/ENVIRONMENTS.md`
438
+
actually defines, and two rows are not additional cohort-operated environments at
439
+
all, but the `deploy/charts/buzz` Helm chart's own two values profiles — `deploy/charts/buzz/README.md`
440
+
labels them "Quickstart (eval)" and "Production (GitOps)", and they belong to
441
+
upstream Block's chart, not to this fork's own environment list:
442
+
443
+
| Environment / chart profile | Source | How `buzz-relay` is deployed |
434
444
|---|---|---|
435
-
|**Local development**|`docker-compose.yml`|`buzz-relay` itself is **not** a service in this file — it runs as a locally built process (`just relay`, per `CLAUDE.md`) against containerized `postgres`, `redis`, `keycloak`, `minio` and `prometheus`, all on one Docker bridge network (`buzz-net`), one instance each, no load balancer, each labeled `com.buzz.env: "dev"`. |
436
-
|**Quickstart / eval**|`deploy/charts/buzz`, `quickstart=true`|`buzz-relay` runs as a Kubernetes `Deployment` (from `templates/deployment.yaml`) alongside **bundled, in-cluster** Postgres, Redis and MinIO subcharts; the chart autogenerates relay and service secrets via Helm's `lookup` function; single replica; installed directly with `helm install`, not GitOps. |
437
-
|**Production**|`deploy/charts/buzz`, default profile | The same `Deployment` template, but pointed at **external, managed** Postgres/Redis/S3 (`externalPostgresql.url`, `externalRedis.url`, `s3.endpoint`) with `secrets.existingSecret` required rather than chart-generated (chart-side secret generation is unsafe once ArgoCD/Flux render the chart with `helm template`, per the chart's own README); `replicaCount >= 2` for HA; a `RollingUpdate` strategy with `maxUnavailable: 0`; deployed via ArgoCD or Flux GitOps (`examples/argocd-app.yaml`, `examples/flux-helmrelease.yaml`). |
445
+
|**Local development** (cohort environment, `launchpad/ENVIRONMENTS.md`, `IMPLEMENTED`) |`docker-compose.yml`|`buzz-relay` itself is **not** a service in this file — it runs as a locally built process (`just relay`, per `CLAUDE.md`) against containerized `postgres`, `redis`, `keycloak`, `minio` and `prometheus`, all on one Docker bridge network (`buzz-net`), one instance each, no load balancer, each labeled `com.buzz.env: "dev"`. |
446
+
|**"Quickstart (eval)" chart profile** (`deploy/charts/buzz`'s own profile, not a cohort environment) |`deploy/charts/buzz`, `quickstart=true`|`buzz-relay` runs as a Kubernetes `Deployment` (from `templates/deployment.yaml`) alongside **bundled, in-cluster** Postgres, Redis and MinIO subcharts; the chart autogenerates relay and service secrets via Helm's `lookup` function; single replica; installed directly with `helm install`, not GitOps. |
447
+
|**"Production (GitOps)" chart profile** (`deploy/charts/buzz`'s own profile, not a cohort environment) |`deploy/charts/buzz`, default profile | The same `Deployment` template, but pointed at **external, managed** Postgres/Redis/S3 (`externalPostgresql.url`, `externalRedis.url`, `s3.endpoint`) with `secrets.existingSecret` required rather than chart-generated (chart-side secret generation is unsafe once ArgoCD/Flux render the chart with `helm template`, per the chart's own README); `replicaCount >= 2` for HA; a `RollingUpdate` strategy with `maxUnavailable: 0`; deployed via ArgoCD or Flux GitOps (`examples/argocd-app.yaml`, `examples/flux-helmrelease.yaml`). |
448
+
449
+
This repository's own operated environments — the cohort's real, tracked list —
450
+
are `launchpad/ENVIRONMENTS.md`'s four rows (Local development, Local VM harness,
451
+
Cohort VPS, Contributors' machines), only one of which (Local development) is
452
+
`IMPLEMENTED` today; the other three are `OPEN`. The chart's "Quickstart" and
453
+
"Production" profiles are not additional rows on that list — they are two ways
454
+
the same upstream Helm chart can be configured, and a real deployment instance
455
+
node should map `buzz-relay` against `ENVIRONMENTS.md`'s own rows, citing the
456
+
chart profile each one would use, rather than treating the chart's profile names
457
+
as environment names in their own right.
438
458
439
459
**One real discrepancy surfaced and deliberately left unresolved.** The `buzz`
440
460
chart's own default `image.repository` is `ghcr.io/block/buzz` — the upstream
0 commit comments