chore: bootstrap repo scaffolding (M0.1)

Adds the §1.2 scaffolding required by IMPLEMENTATION_PLAN.md M0.1: README, CONTRIBUTING, CODEOWNERS, CHANGELOG, PR + issue templates, CI workflow, release workflow, LICENSE, commitlint, cliff config, .editorconfig, .gitignore, .env.example. Refs: M0.1
2026-05-18 21:07:16 +02:00
parent 90b97c9d68
commit ebf627372f
15 changed files with 630 additions and 1 deletions
@@ -1,3 +1,59 @@
 # orca-platform

-IaC for VMs, Orca manifests, DNS, TLS, backups.
+IaC for VMs, Orca manifests, DNS, TLS, backups.
+
+> Part of the **Breakpilot Platform**. For the big picture see [`platform/docs`](https://gitea.meghsakha.com/platform/docs):
+> [Architecture](https://gitea.meghsakha.com/platform/docs/src/branch/main/PLATFORM_ARCHITECTURE.md) ·
+> [Infrastructure](https://gitea.meghsakha.com/platform/docs/src/branch/main/INFRASTRUCTURE.md) ·
+> [Product Integration Spec](https://gitea.meghsakha.com/platform/docs/src/branch/main/PRODUCT_INTEGRATION_SPEC.md) ·
+> [Implementation Plan](https://gitea.meghsakha.com/platform/docs/src/branch/main/IMPLEMENTATION_PLAN.md)
+
+## What this is
+
+IaC for VMs, Orca manifests, DNS, TLS, backups. Scaffolded under milestone M1.1. See [`platform/docs`](https://gitea.meghsakha.com/platform/docs) for the full architecture context.
+
+**Plane:** Infra
+**Owner:** @sharang
+**Status:** pre-alpha
+**Linked milestone:** [M1.1](https://gitea.meghsakha.com/platform/docs/src/branch/main/IMPLEMENTATION_PLAN.md)
+
+## Run locally
+
+```bash
+# prerequisites: see CONTRIBUTING.md for tooling once code lands
+make dev          # starts dependencies + this service on http://localhost:3000
+make test         # unit + integration
+make e2e          # only if this repo ships user-facing flows
+```
+
+Local secrets come from `.env.local` (gitignored). Template at `.env.example`.
+
+## Endpoints / surface
+
+{{For services: list the top-level routes or commands.
+For libraries: list the public API entry points.
+For IaC: list the make targets.}}
+
+## Deployment
+
+| Env   | URL                                  | How                                  |
+|---|---|---|
+| dev   | `http://localhost:3000`          | `make dev`                           |
+| stage | `https://orca-platform.stage.yourplatform.com` | auto on merge to `main`         |
+| prod  | `https://orca-platform.yourplatform.com`  | manual: tag `vX.Y.Z` + sign-off      |
+
+Rollback: `orca rollout undo orca-platform --env={{env}}`.
+
+## Observability
+
+- Traces, logs, metrics: [SigNoz](https://signoz.meghsakha.com) — service name `orca-platform`
+- Audit events: Tenant Registry `/audit` (Retraced-shape schema)
+- On-call: `oncall@yourplatform.com` · runbook at `platform/docs/runbooks/orca-platform.md`
+
+## Contributing
+
+See [`CONTRIBUTING.md`](./CONTRIBUTING.md). TL;DR: branch from main, open a PR, 1 review + green CI, squash-merge.
+
+## License
+
+MIT — see [`LICENSE`](./LICENSE).