Skip to content

Commit c77ec36

Browse files
improve documentation for Stabilized phase
Signed-off-by: Marvin Frommhold <[email protected]>
1 parent 944c768 commit c77ec36

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

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

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -93,13 +93,13 @@ number, and each supplement uses the same document number as the main document i
9393

9494
The second digit in `XXXX` describes the track where the document belongs:
9595

96-
| Track | Number |
97-
| --- | --- |
98-
| Global | 0 |
99-
| IaaS | 1 |
100-
| KaaS | 2 |
101-
| IAM | 3 |
102-
| Ops | 4 |
96+
| Track | Number |
97+
| ------ | ------ |
98+
| Global | 0 |
99+
| IaaS | 1 |
100+
| KaaS | 2 |
101+
| IAM | 3 |
102+
| Ops | 4 |
103103

104104
In addition to the number, each document has the following metadata,
105105
embedded in the markdown header.
@@ -110,7 +110,7 @@ embedded in the markdown header.
110110
| `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) |
113-
| `deprecated_at` | REQUIRED if `status` is `Deprecated` | ISO formatted date indicating the date after which the deprecation is in effect |
113+
| `deprecated_at` | REQUIRED if `status` is `Deprecated` | ISO formatted date indicating the date after which the deprecation is in effect |
114114
| `stabilized_at` | REQUIRED if `status` was ever `Stable` | ISO formatted date indicating the date after which the document was considered stable |
115115
| `rejected_at` | REQUIRED if `status` is `Rejected` | ISO formatted date indicating the date on which the document was rejected |
116116
| `replaced_by` | RECOMMENDED if `status` is `Deprecated` or `Rejected`, FORBIDDEN otherwise | List of documents which replace this document. |
@@ -285,6 +285,8 @@ Changes to the documents are gated through pull requests.
285285

286286
Once the document is deemed ready for production use,
287287
its `status` is changed to `Stable`.
288+
Additionally, the field `stabilized_at` MUST be added and set to a date after which the document is
289+
to be considered stable.
288290

289291
If the document in question is a `Standard`
290292
(and if applicable),

0 commit comments

Comments
 (0)