文档状态定义

规范文档(文件)可以明确定义一个“状态”,通常显示在文档标题的正下方。如果存在,“状态”仅适用于单个文档,而不适用于整个规范或任何其他文档。下表描述了这些状态的含义。

成熟度级别

支持保证和允许的更改受文档成熟度级别的约束。成熟度级别在 OTEP 0232 中定义,并遵循 OpenTelemetry 项目关于描述组件成熟度的标准框架。

状态解释
没有明确的“状态”相当于 Alpha。
开发组件的某些部分尚未就绪,可能仍未对用户可用。预计会报告 Bug 和性能问题。我们希望收到用户关于组件用户体验的反馈,例如配置选项、组件可观测性、技术实现细节以及组件的预期用途。由于事态发展,配置选项可能会经常发生更改。组件不应在生产环境中使用。组件可能随时移除,恕不另行通知。
Alpha组件已准备好用于有限的非关键生产工作负载,并且此组件的作者欢迎用户反馈。我们鼓励报告 Bug 和性能问题,但组件所有者可能不会立即处理它们。组件的接口和配置选项可能会经常更改,恕不保证向后兼容。处于此阶段的组件可能随时被放弃,恕不另行通知。
Beta与 Alpha 相同,但接口(API、配置、生成的遥测数据)在可能的情况下被视为稳定。尽管版本之间可能存在破坏性更改,但组件所有者应尽量减少它们。处于此阶段的组件应已在 Alpha 阶段接触过非关键生产工作负载,因此适合更广泛地使用。
发布候选组件已完成功能开发,可供广泛使用。组件已准备好被宣布为稳定,可能只需要在更多生产环境中进行测试。预计会报告 Bug 和性能问题,并且组件所有者将致力于解决它们。破坏性更改,包括配置选项和组件的输出,仅在特殊情况下允许。在可能的情况下,应提前通知用户有关破坏性更改的信息。
稳定组件已准备好进行普遍可用。应报告 Bug 和性能问题,并且组件所有者将致力于解决它们。破坏性更改,包括配置选项和组件的输出,仅在特殊情况下允许。在可能的情况下,应提前通知用户有关破坏性更改的信息。有关详细信息,请参阅 稳定性保证
已弃用此组件的开发已停止。不计划发布新版本,并且该组件可能会从其包含的发行版中删除。请注意,除关键安全问题外,新问题可能不会得到处理。包含在发行版中的组件预计将至少存在两个次要版本或六个月(以较晚者为准)。它们还必须说明将在哪个版本中删除它们。
未维护被标识为未维护的组件没有活动的代码所有者。此类组件可能从未被分配代码所有者,或者之前活跃的代码所有者在联系后 6 周内未响应反馈请求。未维护组件的问题和拉取请求应被标记为“未维护”。在未维护 6 个月后,这些组件可能会被弃用。未维护组件正在积极寻找贡献者来担任代码所有者。

该规范遵循 OTEP 0232 的成熟度级别定义。

混合

某些文档的各个部分具有不同的状态。这些文档顶部标记为“混合”状态,以示清晰。