Skip to content

Commit a7643d7

Browse files
committed
Remove Status field from Supplement docs
This field causes some confusion for Supplement docs, for the standard scs-0001-v1 merely states that these docs may be kept in Draft state, which provides no certainty as to what should be done. Here, I propose to go for maximum certainty by simply stating they are kept in Draft state in perpetuity, and therefore, the field is not even present in them. Signed-off-by: Matthias Büchse <[email protected]>
1 parent 4cbdef9 commit a7643d7

17 files changed

+7
-20
lines changed

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

Lines changed: 7 additions & 4 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 `Draft`, `Stable`, `Deprecated`, or `Rejected` |
110+
| `status` | REQUIRED precisely when `type` is not `Supplement` | 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 |
@@ -193,7 +193,9 @@ In case there is little or no activity in some team, the SIG Standardization/Cer
193193
can take decisions on behalf of such a team. The SIG will seek alignment with the Project
194194
Board for decisions with large impact to ensure we have the wanted broad alignment.
195195

196-
Supplements may be kept in Draft state, because they are not authoritative.
196+
From this perspective,
197+
Supplements are perpetually kept in Draft state, because they are not authoritative,
198+
and this state is not recorded in the document (i.e., no Status field).
197199

198200
### Proposal phase
199201

@@ -223,8 +225,9 @@ for a Supplement of `scs-0100-v3-flavor-naming.md`,
223225
the file name might be `scs-0100-w1-flavor-naming-implementation-testing.md` (note the `w1`!).
224226

225227
The metadata MUST indicate the intended `track` and `type` of the document,
226-
and the `status` MUST be set to `Draft`;
227-
for a Supplement, the `supplements` field MUST be set
228+
and the `status` MUST be set to `Draft`,
229+
except for a Supplement;
230+
where, instead, the `supplements` field MUST be set
228231
to a list of documents (usually containing one element).
229232

230233
Upon acceptance by the group of people identified by the `track`,

Standards/scs-0004-w1-achieving-certification-implementation.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: "Implementation hints for achieving SCS-compatible certification"
33
type: Supplement
44
track: Global
5-
status: Draft
65
supplements:
76
- scs-0004-v1-achieving-certification.md
87
---

Standards/scs-0007-w1-certification-integrators-implementation-notes.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: "Implementation hints for achieving Certified SCS Integrator"
33
type: Supplement
44
track: Global
5-
status: Stable
65
supplements:
76
- scs-0007-v1-certification-integrators.md
87
---

Standards/scs-0100-w1-flavor-naming-implementation-testing.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: "SCS Flavor Naming Standard: Implementation and Testing Notes"
33
type: Supplement
44
track: IaaS
5-
status: Draft
65
supplements:
76
- scs-0100-v1-flavor-naming.md
87
- scs-0100-v2-flavor-naming.md

Standards/scs-0101-w1-entropy-implementation-testing.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: "SCS Entropy: Implementation and Testing Notes"
33
type: Supplement
44
track: IaaS
5-
status: Draft
65
supplements:
76
- scs-0101-v1-entropy.md
87
---

Standards/scs-0102-w1-image-metadata-implementation-testing.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: "SCS Image Metadata: Implementation and Testing Notes"
33
type: Supplement
44
track: IaaS
5-
status: Draft
65
supplements:
76
- scs-0102-v1-image-metadata.md
87
---

Standards/scs-0104-w1-standard-images-implementation.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: "SCS Standard Images: Implementation and Testing Notes"
33
type: Supplement
44
track: IaaS
5-
status: Draft
65
supplements:
76
- scs-0104-v1-standard-images.md
87
---

Standards/scs-0116-w1-key-manager-implementation-testing.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: "SCS Key Manager Standard: Implementation and Testing Notes"
33
type: Supplement
44
track: IaaS
5-
status: Draft
65
supplements:
76
- scs-0116-v1-key-manager-standard.md
87
---

Standards/scs-0118-w1-example-impacts-of-failure-scenarios.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: "SCS Taxonomy of Failsafe Levels: Examples of Failure Cases and their impact on IaaS and KaaS resources"
33
type: Supplement
44
track: IaaS
5-
status: Draft
65
supplements:
76
- scs-0118-v1-taxonomy-of-failsafe-levels.md
87
---

Standards/scs-0121-w1-Availability-Zones-Standard.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: "SCS Availability Zones: Implementation and Testing Notes"
33
type: Supplement
44
track: IaaS
5-
status: Draft
65
supplements:
76
- scs-0121-v1-Availability-Zones-Standard.md
87
---

0 commit comments

Comments
 (0)