Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,7 @@ README.md SPEC.md MOTIVATION.md CONTRIBUTING.md CHANGELOG.md
schemas/ # Map v2 JSON Schema
legacy/v1/ # historical zones map
templates/ # minimal-map, orientation, stream-pack, artifacts
examples/ # single-repo, shell, hub-umbrella, stream-packs, invalid
examples/ # single-repo, shell, hub-umbrella, meta-repo, stream-packs, invalid
cookbook/ # optional profiles + patterns
scripts/validate.py
```
Expand Down
15 changes: 15 additions & 0 deletions examples/meta-repo/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Example: meta-repo shell (fictional)

Synthetic multi-repo **shell** for hub orientation. All names
(`acme-platform`, `orders-api`, `admin-web`, `billing-worker`,
`external-gateway`) are **fictional** — not a real product.

| Path | Role |
|------|------|
| `map.yaml` | Hub: hops, `business`/`reports` layout, read-only external |
| `orders-api/map.yaml` | Child with `self.parent` → hub |
| `admin-web/map.yaml` | Child with `self.parent` → hub |
| `billing-worker/map.yaml` | Child with `self.parent` → hub |

Parent hops + consume-only external. See [`../hub-umbrella/`](../hub-umbrella/)
and [`../../cookbook/hub-umbrella.md`](../../cookbook/hub-umbrella.md).
23 changes: 23 additions & 0 deletions examples/meta-repo/admin-web/map.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# yaml-language-server: $schema=../../../schemas/map.schema.json
# Fictional child map. self.parent is navigation only (not ownership).
version: 2
workspace:
id: admin-web
description: Fictional operator UI (child of acme-platform).
self:
id: admin-web
kind: repository
path: .
description: Admin web checkout (synthetic).
parent:
id: acme-platform
locator:
repo: example/acme-platform
map:
path: map.yaml
layout:
code: src/
tests: tests/
artifacts: docs/artifacts/
scratch: docs/scratch/
nodes: []
24 changes: 24 additions & 0 deletions examples/meta-repo/billing-worker/map.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# yaml-language-server: $schema=../../../schemas/map.schema.json
# Fictional child map. self.parent is navigation only (not ownership).
version: 2
workspace:
id: billing-worker
description: Fictional billing worker (child of acme-platform).
self:
id: billing-worker
kind: repository
path: .
description: Billing worker checkout (synthetic).
parent:
id: acme-platform
locator:
repo: example/acme-platform
map:
path: map.yaml
layout:
code: src/
tests: tests/
artifacts: docs/artifacts/
scratch: docs/scratch/
devops: deploy/
nodes: []
59 changes: 59 additions & 0 deletions examples/meta-repo/map.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# yaml-language-server: $schema=../../schemas/map.schema.json
# Fictional meta-repo shell. Names are synthetic teaching fixtures only.
# Nodes = direct hops from THIS workspace (not a full dependency graph).
version: 2
workspace:
id: acme-platform
description: >
Fictional multi-repo shell for teaching hub orientation, parent hops,
layout extensions, and a read-only external node.
self:
id: acme-platform
kind: repository
path: .
description: Fictional umbrella checkout root (not a real product).
layout:
artifacts: docs/artifacts/
scratch: docs/scratch/
# Extension layout key — business/report artifacts (allowed by additionalProperties).
business: docs/business/
reports: docs/business/reports/
nodes:
- id: orders-api
kind: repository
path: orders-api
description: Fictional orders domain service.
locator:
repo: example/acme-orders-api
map:
path: map.yaml
write:
- domain
- id: admin-web
kind: repository
path: admin-web
description: Fictional operator UI for the platform shell.
locator:
repo: example/acme-admin-web
map:
path: map.yaml
write:
- domain
- id: billing-worker
kind: repository
path: billing-worker
description: Fictional async billing / invoice worker.
locator:
repo: example/acme-billing-worker
map:
path: map.yaml
write:
- domain
- id: external-gateway
kind: external
description: >
Fictional partner edge gateway — consume-only external dependency;
this shell does not curate its tree.
locator:
repo: example/partner-external-gateway
access: read-only
23 changes: 23 additions & 0 deletions examples/meta-repo/orders-api/map.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# yaml-language-server: $schema=../../../schemas/map.schema.json
# Fictional child map. self.parent is navigation only (not ownership).
version: 2
workspace:
id: orders-api
description: Fictional orders domain service (child of acme-platform).
self:
id: orders-api
kind: repository
path: .
description: Orders API checkout (synthetic).
parent:
id: acme-platform
locator:
repo: example/acme-platform
map:
path: map.yaml
layout:
code: src/
tests: tests/
artifacts: docs/artifacts/
scratch: docs/scratch/
nodes: []
Loading