From 4582aecfaef8672bdfbe38649b256e92a0a0a52e Mon Sep 17 00:00:00 2001 From: Markus Hentsch <129268441+markus-hentsch@users.noreply.github.com> Date: Fri, 20 Sep 2024 14:23:37 +0200 Subject: [PATCH] Update scs-0001-v1-sovereign-cloud-standards.md (#754) Use "Draft" state for the whole proposal phase and remove the unnecessary preceeding "Proposal" state for standards to steamline the process for contributors. Emphasize that it is encouraged to present new standard proposals to the SCS community early on (even in unfinished state) and reference the community page. Signed-off-by: Markus Hentsch <129268441+markus-hentsch@users.noreply.github.com> --- .../scs-0001-v1-sovereign-cloud-standards.md | 22 +++++++++++++------ 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/Standards/scs-0001-v1-sovereign-cloud-standards.md b/Standards/scs-0001-v1-sovereign-cloud-standards.md index 48ef64c49..eabfff020 100644 --- a/Standards/scs-0001-v1-sovereign-cloud-standards.md +++ b/Standards/scs-0001-v1-sovereign-cloud-standards.md @@ -107,7 +107,7 @@ embedded in the markdown header. | Field name | Requirement | Description | | --------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `type` | REQUIRED | one of `Procedural`, `Standard`, `Decision Record`, or `Supplement` | -| `status` | REQUIRED | one of `Proposal`, `Draft`, `Stable`, `Deprecated`, or `Rejected` | +| `status` | REQUIRED | one of `Draft`, `Stable`, `Deprecated`, or `Rejected` | | `track` | REQUIRED | one of `Global`, `IaaS`, `KaaS`, `IAM`, `Ops` | | `supplements` | REQUIRED precisely when `type` is `Supplement` | list of documents that are extended by this document (e.g., multiple major versions) | | `deprecated_at` | REQUIRED if `status` is `Deprecated` | ISO formatted date indicating the date after which the deprecation is in effect | @@ -167,11 +167,11 @@ In addition, the following OPTIONAL sections should be considered: ## Process The lifecycle of an SCS document goes through the following phases: -Proposal, Draft, Stable, Deprecated, and Rejected. +Draft, Stable, Deprecated, and Rejected. ```mermaid graph TD - A[Proposal] -->|Pull Request| B[Draft] + A["Draft (Proposal)"] -->|Pull Request| B[Draft] B -->|Pull Request| D[Stable] B -->|Pull Request| E[Rejected] D -->|Pull Request| F[Deprecated] @@ -195,8 +195,15 @@ Supplements may be kept in Draft state, because they are not authoritative. To propose a new SCS document, a community participant creates a pull request on GitHub against the [standards repository in the SovereignCloudStack organisation][scs-standards-repo]. - -The pull request MUST add exactly one SCS document, +In the beginning, the pull request will contain a draft of an SCS document and +the community participant should present it to the SCS community. +They may refer to the [SCS Community page](https://docs.scs.community/community/) +for an overview of applicable means of communication and online meetings +to get in touch with the SCS community. +Community participants are encouraged to present their proposal to the SCS community early on. +Note that the proposal draft's content does not need to be finished in any way at this stage. + +The pull request for the proposal MUST add exactly one SCS document, in the `Standards` folder. In the proposal phase, the document number MUST be replaced with `xxxx` in the file name, @@ -209,7 +216,7 @@ for a Supplement of `scs-0100-v3-flavor-naming.md`, the file name might be `scs-0100-w1-flavor-naming-implementation-testing.md` (note the `w1`!). The metadata MUST indicate the intended `track` and `type` of the document, -and the `status` MUST be set to `Proposal`; +and the `status` MUST be set to `Draft`; for a Supplement, the `supplements` field MUST be set to a list of documents (usually containing one element). @@ -217,7 +224,8 @@ Upon acceptance by the group of people identified by the `track`, a number is assigned (the next unused number) and the proposer is asked -to rename the file to replace the `xxxx` with that number. +to rename the file to replace the `xxxx` with that number +before the merge of the pull request. **Note:** Documents on the `Design Record` track MAY be proposed or accepted directly into `Stable` state,