添加新文档

---

贡献新文档到 KubeGems，请先执行以下步骤：

• 确定受众和信息的预期用途。

• 选择您想要贡献的内容类型。

• 命名标题。

• 按照文档贡献指南撰写您的贡献。

• 将您的贡献提交到 Gitlab 存储库。

• 执行审核流程，直到您的贡献被合并。

确定受众和信息的预期用途

好的文档需要从了解读者的阅读目的，知识面以及希望他们如何处理这些信息开始。否则，您无法确定要提供的信息的范围和深度、 理想结构和必要的支持信息。以下示例描述如何在实际操作中践行该准则：

• 读者需要执行特定的任务：告诉他们如何识别哪些是需要执行的任务，并以编号步骤列表的形式提供任务细节，而不是简单地概括性地描述任务。

• 读者在执行任务之前必须理解一个概念：在执行任务之前，请先介绍先决条件并提供指向该信息的链接。

• 读者需要做出决定：提供必要的概念性信息，以了解何时做出决定，可用选项以及何时选择一个选项而不是另一个。

• 读者是运维人员，而不是软件工程师（SWE）：提供执行脚本，而不是开发人员指南中的代码示例链接。

• 读者需要扩展产品的功能：提供一个如何扩展功能的示例，并使用简化方案进行说明。

• 读者需要理解复杂的功能关系：提供一个显示关系的图表，而不是编写大量文字信息供阅读理解。

• 要避免的最重要也是最常见的错误，是简单地向读者提供您拥有的所有信息，因为您不确定他们需要什么信息。

内容类型

了解受众和所提供信息的预期用途后，您可以选择最能满足他们需求的内容类型。为了方便您选择， 下表提供了受支持的内容类型、预期受众及每种类型文档的实施目标：

内容类型	目标	受众
概念（concepts）	解释KubeGems相关的内容，例如多租户管理、AI模型管理等功能。概念页面不包含步骤序列。文档里面涉及到到相关任务提供链接快速访问	想要了解KubeGems工作原理，以及产品功能和架构的基础知识。
部署指南（installation）	着重于完成 KubeGems 部署所需的安装步骤。	想要完成部署KubeGems的 用户。
使用指南（operations）	着重介绍使用 KubeGems 功能的单个任务。任务包含按步骤序列编写的过程。 任务仅提供对功能的最少说明。	想要使用KubeGems完整功能的用户。
文档发布（public）	介绍本站文档的贡献说明	想要向KubeGems贡献文档的用户
参考（reference）	介绍KubeGems的设计和一些CRD相关的说明	想要深入了解KubeGems的设计、开发等细节的用户

命名标题

为您的主题选择一个标题，该标题具有您希望搜索引擎查找的关键字。KubeGems中的所有内容文件都被命名为<xxx>.md， 但是每个内容文件都存放在用对应的目录当中并用连字符分隔，所有字母均小写。文件夹名称应尽可能短， 以使交叉引用更易于创建和维护。

撰写文章

在撰写文章前，您需要着重了解本站的静态资源存储路径，并将自己贡献的文档按如下方式存储。

类型	路径	功能
文档	./docs	本站的所有产品相关文档
博客	./blog	与 KubeGems 相关的技术博客
图片	./assets	本站文章中的图片资源路径，跟文档位于同级目录