Skip to content

Commit db08bce

Browse files
MrAliasMrAlias
authored
Update document statuses (#107)
* Update document statuses * Link to README section
1 parent c9b9379 commit db08bce

File tree

6 files changed

+49
-42
lines changed

6 files changed

+49
-42
lines changed

‎README.md

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ implementation of the GDI specification is compliant if it satisfies all the
5353
"MUST", "MUST NOT", "REQUIRED", "SHALL", and "SHALL NOT" requirements defined
5454
in the GDI specification.
5555

56-
## Versioning the Specification
56+
## Versioning and Status of the Specification
5757

5858
Changes to the GDI specification are versioned according to [Semantic
5959
Versioning 2.0](https://semver.org/spec/v2.0.0.html) and described in
@@ -63,7 +63,46 @@ that implement the specification MUST specify which version they implement.
6363
Changes to the change process itself are not currently versioned but may be
6464
independently versioned in the future.
6565

66-
Additionally, the GDI specification uses following [Document Statuses](specification/document-status.md).
66+
Specification documents (files) MAY explicitly define a "Status". If they do,
67+
they MUST display a status immediately after the document title. When
68+
present, the "Status" applies to the individual document only and not to the
69+
entire specification or any other documents.
70+
71+
### Lifecycle status
72+
73+
The support guarantees and allowed changes are governed by the lifecycle of the
74+
document. Lifecycle stages are defined in the
75+
[versioning](./specification/versioning.md) document.
76+
77+
|Status |Explanation|
78+
|--------------------|-----------|
79+
|No explicit "Status"|Equivalent to Experimental.|
80+
|Experimental |Breaking changes are allowed.|
81+
|Stable |Breaking changes are no longer allowed. [1]|
82+
|Deprecated |Changes are no longer allowed, except for editorial changes.|
83+
84+
- [1]: See [stability guarantees](./specification/versioning.md) for details.
85+
86+
### Feature freeze
87+
88+
In addition to the statuses above, documents may be marked as `Feature-freeze`.
89+
These documents are not currently accepting new feature requests, to allow the
90+
GDI specification maintainers time to focus on other areas of the specification.
91+
Editorial changes are still accepted. Changes that address production issues
92+
with existing features are still accepted.
93+
94+
Feature freeze is separate from a lifecycle status. The lifecycle represents
95+
the support requirements for the document, feature freeze only indicates the
96+
current focus of the specification community. The feature freeze label may be
97+
applied to a document at any lifecycle stage. By definition, deprecated
98+
documents have a feature freeze in place.
99+
100+
### Mixed
101+
102+
Some documents have individual sections with different statues. These documents
103+
MUST be marked with the status `Mixed` at the top, for clarity. If a document's
104+
status is marked as `Mixed` then it MUST define at least two different statuses
105+
in sections that follow within the document.
67106

68107
## Contributions
69108

‎specification/configuration.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Configuration
22

3+
**Status**: [Stable](../README.md#versioning-and-status-of-the-specification)
4+
35
One or more configuration variables MAY be needed to properly configure GDI
46
repositories. Configuration of these variables MUST be supported by environment
57
variables and MAY be supported by additional methods. GDI repositories MUST adopt

‎specification/document-status.md

Lines changed: 0 additions & 40 deletions
This file was deleted.

‎specification/repository.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Repository
22

3+
**Status**: [Stable](../README.md#versioning-and-status-of-the-specification)
4+
35
Every GDI repository MUST adhere to the following specification before
46
it can release a GA (`1.0.0`) release. GDI repositories MUST submit a GitHub issue
57
on the GDI specification using the `Repository GA approval` type. Until the

‎specification/semantic_conventions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Semantic Conventions
22

3+
**Status**: [Stable](../README.md#versioning-and-status-of-the-specification)
4+
35
This document defines the OpenTelemetry and Splunk specific standard attributes for Splunk distributions of OpenTelemetry.
46

57
## OpenTelemetry Resource Attributes

‎specification/versioning.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Versioning
22

3+
**Status**: [Stable](../README.md#versioning-and-status-of-the-specification)
4+
35
All GDI components MUST be versioned according to [Semantic Versioning
46
2.0](https://semver.org/spec/v2.0.0.html). GDI components are versioned
57
separately from OpenTelemetry components as Splunk-specific breaking changes

0 commit comments

Comments
 (0)