Skip to content

Commit 4582aec

Browse files
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 <[email protected]>
1 parent d5e1245 commit 4582aec

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

Standards/scs-0001-v1-sovereign-cloud-standards.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ embedded in the markdown header.
107107
| Field name | Requirement | Description |
108108
| --------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
109109
| `type` | REQUIRED | one of `Procedural`, `Standard`, `Decision Record`, or `Supplement` |
110-
| `status` | REQUIRED | one of `Proposal`, `Draft`, `Stable`, `Deprecated`, or `Rejected` |
110+
| `status` | REQUIRED | one of `Draft`, `Stable`, `Deprecated`, or `Rejected` |
111111
| `track` | REQUIRED | one of `Global`, `IaaS`, `KaaS`, `IAM`, `Ops` |
112112
| `supplements` | REQUIRED precisely when `type` is `Supplement` | list of documents that are extended by this document (e.g., multiple major versions) |
113113
| `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:
167167
## Process
168168

169169
The lifecycle of an SCS document goes through the following phases:
170-
Proposal, Draft, Stable, Deprecated, and Rejected.
170+
Draft, Stable, Deprecated, and Rejected.
171171

172172
```mermaid
173173
graph TD
174-
A[Proposal] -->|Pull Request| B[Draft]
174+
A["Draft (Proposal)"] -->|Pull Request| B[Draft]
175175
B -->|Pull Request| D[Stable]
176176
B -->|Pull Request| E[Rejected]
177177
D -->|Pull Request| F[Deprecated]
@@ -195,8 +195,15 @@ Supplements may be kept in Draft state, because they are not authoritative.
195195
To propose a new SCS document,
196196
a community participant creates a pull request on GitHub
197197
against the [standards repository in the SovereignCloudStack organisation][scs-standards-repo].
198-
199-
The pull request MUST add exactly one SCS document,
198+
In the beginning, the pull request will contain a draft of an SCS document and
199+
the community participant should present it to the SCS community.
200+
They may refer to the [SCS Community page](https://docs.scs.community/community/)
201+
for an overview of applicable means of communication and online meetings
202+
to get in touch with the SCS community.
203+
Community participants are encouraged to present their proposal to the SCS community early on.
204+
Note that the proposal draft's content does not need to be finished in any way at this stage.
205+
206+
The pull request for the proposal MUST add exactly one SCS document,
200207
in the `Standards` folder.
201208
In the proposal phase,
202209
the document number MUST be replaced with `xxxx` in the file name,
@@ -209,15 +216,16 @@ for a Supplement of `scs-0100-v3-flavor-naming.md`,
209216
the file name might be `scs-0100-w1-flavor-naming-implementation-testing.md` (note the `w1`!).
210217

211218
The metadata MUST indicate the intended `track` and `type` of the document,
212-
and the `status` MUST be set to `Proposal`;
219+
and the `status` MUST be set to `Draft`;
213220
for a Supplement, the `supplements` field MUST be set
214221
to a list of documents (usually containing one element).
215222

216223
Upon acceptance by the group of people identified by the `track`,
217224
a number is assigned
218225
(the next unused number)
219226
and the proposer is asked
220-
to rename the file to replace the `xxxx` with that number.
227+
to rename the file to replace the `xxxx` with that number
228+
before the merge of the pull request.
221229

222230
**Note:**
223231
Documents on the `Design Record` track MAY be proposed or accepted directly into `Stable` state,

0 commit comments

Comments
 (0)