文档风格指南¶

网关 API 旨在尽可能地遵循上游 Kubernetes 文档风格指南。此指南应被视为该指南的扩展。如有冲突的指南，本指南中包含的信息优先于网关 API 文档。

项目名称¶

此项目名为“网关 API”，而不是“网关 API”。因此，使用“网关 API”的唯一情况是它属于更广泛的术语的一部分，例如“网关 API 维护者”。

提示¶

为了在文档中实现提示，我们使用 mkdocs-material 提醒.

发布渠道¶

只要有可能，我们都会尽量明确说明某个资源或功能当前包含在哪个发布渠道中，以及它是在哪个版本中引入到该渠道的。为此，我们使用类似于以下的提醒

图表¶

在许多情况下，图表是解释概念的最佳方式。不幸的是，它们可能难以维护和更新。为了确保图表更易于维护，我们强烈建议使用对 Mermaid 图表的内置支持。以下是一个简单的图表示例

flowchart TD
    Start --> Stop

只要使用 Mermaid 图表不切实际，我们要求您链接到一个资源，以便任何人都可以复制和编辑该资源。