generated from coulomb/repo-seed
tegwick
a52b77a0e7
T04: add docs/canon-mapping.md mapping config-atlas concepts to InfoTechCanon (itc-gov/data/devsecops/land/org/access/sec/tag) and sibling repos with consume/reference/align/own ownership, plus gaps, validation hooks, and extension candidates. Resolves the (planned) refs in PRD and ecosystem-boundaries. T01: add schemas/surface-entry.schema.json (Draft 2020-12, additionalProperties false to forbid inline values/secrets), docs/configuration-surface-schema.md (fields, kind taxonomy, L0-L9 ordering, explicit merge rules), a validating seed entry (surface.infotech.state-hub.api-config), and expand registry/README.md. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
29 lines
1.2 KiB
Markdown
29 lines
1.2 KiB
Markdown
# Registry
|
|
|
|
Markdown-first registry for config-atlas. Two entry families:
|
|
|
|
- **Configuration surfaces** (`surfaces/`) — the atlas's core artifact. Each entry
|
|
maps a configuration surface (where it lives, owner, kind, scope, source links),
|
|
validated against [`../schemas/surface-entry.schema.json`](../schemas/surface-entry.schema.json).
|
|
See [`../docs/configuration-surface-schema.md`](../docs/configuration-surface-schema.md)
|
|
for the model and [`../docs/canon-mapping.md`](../docs/canon-mapping.md) for ITC alignment.
|
|
Index: `indexes/surfaces.yaml` (ATLAS-WP-0002-T03).
|
|
- **Capabilities** (`capabilities/`) — capability index for reuse-surface federation
|
|
(below).
|
|
|
|
Surfaces store the **map only** — never live configuration values, never secret
|
|
values.
|
|
|
|
## Capability Registry
|
|
|
|
Markdown-first capability index for federation and reuse planning.
|
|
|
|
## Authoring
|
|
|
|
1. Copy a capability entry template (see reuse-surface `templates/capability-entry.template.md`).
|
|
2. Add the row to `indexes/capabilities.yaml`.
|
|
3. Run `reuse-surface validate` from a checkout with the CLI installed.
|
|
4. Merge to `main` and verify publish with `reuse-surface establish --publish-check`.
|
|
|
|
Federation contract: reuse-surface `docs/RegistryFederation.md`.
|