From 1c6425f654325416a598bb259fbfa2e87f291b0f Mon Sep 17 00:00:00 2001 From: Sung-Kyu Yoo Date: Tue, 11 Aug 2026 03:26:51 +0900 Subject: [PATCH 1/2] docs: stop describing DevCloud as pre-1.0 in what the release archive ships MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The archive carries the docs/ tree and GOVERNANCE.md (#127), and v1.0 is the first tag where that is true. Unpacked, it would have handed a user a roadmap listing v1.0 as pending and a governance doc calling the API unstable, beside a compatibility-policy.md stating what 1.x guarantees. Phase 1 is marked complete, the version table's current marker moves to 1.x, and the governance note now says what it meant — how decisions are made, not how stable the API is. --- GOVERNANCE.md | 5 +++-- changes/unreleased/Documentation-20260811-140000.yaml | 5 +++++ docs/roadmap.md | 10 +++++----- 3 files changed, 13 insertions(+), 7 deletions(-) create mode 100644 changes/unreleased/Documentation-20260811-140000.yaml diff --git a/GOVERNANCE.md b/GOVERNANCE.md index f886014..1c50dc8 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -2,13 +2,14 @@ DevCloud is a small, volunteer-driven open-source project. This document describes how decisions are made and how the roles evolve as the project grows. -## Current state (0.x) +## Current state - **Benevolent maintainer model.** One maintainer ([@skyoo2003](https://github.com/skyoo2003)) has final say on roadmap, releases, and merge decisions. - **Apache License 2.0.** All contributions are accepted under this license; see [CONTRIBUTING.md](CONTRIBUTING.md). - **Best-effort response.** No SLA; see [SUPPORT.md](SUPPORT.md) for expectations. -This is appropriate while the project is pre-1.0 and scope is still being proven. +This is appropriate at the project's current size. It is a statement about who decides, not about +API stability — what a release promises is [docs/compatibility-policy.md](docs/compatibility-policy.md). ## How decisions are made diff --git a/changes/unreleased/Documentation-20260811-140000.yaml b/changes/unreleased/Documentation-20260811-140000.yaml new file mode 100644 index 0000000..caaf516 --- /dev/null +++ b/changes/unreleased/Documentation-20260811-140000.yaml @@ -0,0 +1,5 @@ +kind: Documentation +body: The roadmap and governance docs no longer describe DevCloud as pre-1.0. Both ship inside the release archive, so a v1.0 download would have carried a roadmap listing its own release as pending and a governance doc calling the API unstable — contradicting the compatibility policy packaged beside them +time: 2026-08-11T14:00:00.000000+09:00 +custom: + Issue: "130" diff --git a/docs/roadmap.md b/docs/roadmap.md index faa885d..a209b9d 100644 --- a/docs/roadmap.md +++ b/docs/roadmap.md @@ -14,7 +14,7 @@ We pursue this vision through a **phased rollout** to manage scope, architectura ## Phases -### Phase 1 — AWS Depth & Stabilization (Current, targeting v1.0) +### Phase 1 — AWS Depth & Stabilization (Complete, shipped as v1.0) **Goal**: mature the already-broad AWS surface into a stable, well-tested v1.0. @@ -27,9 +27,9 @@ We pursue this vision through a **phased rollout** to manage scope, architectura - [x] boto3 compatibility coverage added for previously-untested services (CodeConnections, DMS, Verified Permissions) - [x] Stable `ServicePlugin` API finalized and documented ([plugin-api.md](plugin-api.md)), enforced by a conformance test over every registered service - [x] Generic CRUD fallback engine ([crud-engine.md](crud-engine.md)) auto-serves ~2,200 CRUD-shaped operations across all 46 JSON-protocol services with plausible, store-backed responses; every registered JSON service is wired. **Follow-up**: promote high-value auto-crud ops to hand-verified fidelity. -- [ ] v1.0 release (pending maintainer tag) +- [x] v1.0 release — see [compatibility-policy.md](compatibility-policy.md) for what 1.x guarantees -### Phase 2 — Architectural Preparation (v1.x) +### Phase 2 — Architectural Preparation (Current, v1.x) **Goal**: internal refactor so adding a new CSP doesn't require forking the project. @@ -75,7 +75,7 @@ We pursue this vision through a **phased rollout** to manage scope, architectura | Version | Focus | |---------|-------| -| 0.x ← current | AWS services, unstable API | -| 1.x | AWS depth, stable plugin API | +| 0.x | AWS services, unstable API | +| 1.x ← current | AWS depth, stable plugin API | | 2.x | Multi-CSP architecture, Azure pilot | | 3.x+ | Broad CSP coverage, community-owned providers | From a03e4108aadf8e20fea48b2df0d958bcf9a9e862 Mon Sep 17 00:00:00 2001 From: Sung-Kyu Yoo Date: Tue, 11 Aug 2026 03:33:10 +0900 Subject: [PATCH 2/2] docs: align the architecture phase markers with the roadmap MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Moving the roadmap's current marker to Phase 2 left architecture.md line 9 still naming Phase 1 as current, so the two docs — both packaged in the release archive — gave different answers to which phase is active. --- changes/unreleased/Documentation-20260811-140000.yaml | 2 +- docs/architecture.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/changes/unreleased/Documentation-20260811-140000.yaml b/changes/unreleased/Documentation-20260811-140000.yaml index caaf516..bccd118 100644 --- a/changes/unreleased/Documentation-20260811-140000.yaml +++ b/changes/unreleased/Documentation-20260811-140000.yaml @@ -1,5 +1,5 @@ kind: Documentation -body: The roadmap and governance docs no longer describe DevCloud as pre-1.0. Both ship inside the release archive, so a v1.0 download would have carried a roadmap listing its own release as pending and a governance doc calling the API unstable — contradicting the compatibility policy packaged beside them +body: The roadmap, architecture and governance docs no longer describe DevCloud as pre-1.0. All three ship inside the release archive, so a v1.0 download would have carried a roadmap listing its own release as pending, an architecture overview naming Phase 1 as current, and a governance doc calling the API unstable — contradicting the compatibility policy packaged beside them time: 2026-08-11T14:00:00.000000+09:00 custom: Issue: "130" diff --git a/docs/architecture.md b/docs/architecture.md index 0376f4d..d53a40a 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -6,8 +6,8 @@ DevCloud's long-term direction is to support multiple Cloud Service Providers (A A phased refactor is planned (see [roadmap.md](roadmap.md)): -- **Phase 1 (current)** — AWS services via Smithy codegen, single-port gateway, AWS SigV4 auth. -- **Phase 2 (preparation)** — Introduce an Intermediate Representation (IR) between API models and codegen. Abstract `ModelSource` so OpenAPI (Azure) and Protocol Buffers / Discovery Documents (GCP) can feed the same pipeline. Extract a per-provider auth adapter interface. +- **Phase 1 (complete, shipped as v1.0)** — AWS services via Smithy codegen, single-port gateway, AWS SigV4 auth. +- **Phase 2 (current)** — Introduce an Intermediate Representation (IR) between API models and codegen. Abstract `ModelSource` so OpenAPI (Azure) and Protocol Buffers / Discovery Documents (GCP) can feed the same pipeline. Extract a per-provider auth adapter interface. - **Phase 3 (pilot)** — First non-AWS service (candidate: Azure Blob Storage) validates the multi-CSP architecture. - **Phase 4 (breadth)** — Additional services across CSPs; community-owned providers.