Skip to content

Commit

Permalink
Update scs-0001-v1-sovereign-cloud-standards.md (#754)
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
markus-hentsch authored Sep 20, 2024
1 parent d5e1245 commit 4582aec
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions Standards/scs-0001-v1-sovereign-cloud-standards.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down Expand Up @@ -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]
Expand All @@ -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,
Expand All @@ -209,15 +216,16 @@ 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).

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,
Expand Down

0 comments on commit 4582aec

Please sign in to comment.