文档 #

本文档详细介绍如何为文档做出贡献。

我们的文档是使用 hugo 构建的，就像 kubernetes.io 一样。我们提供了一个使用 hugo 的开发 makefile。

目录结构 #

• site
  • content - Markdown 内容源
    • en
      • docs
        • contributing - 贡献文档
        • design - 设计文档
        • user - 用户文档
      • menu - 左侧导航菜单
      • posts - 博客文章
  • static - 静态资产

创建新页面 #

要创建新页面，请在适当的目录下创建一个新的 markdown 文件，并在适当的菜单中添加指向它的链接。

构建 #

对于简单的内容更改，您还可以只编辑 markdown 源并发送拉取请求。将创建构建预览并回复您的拉取请求。

对于更复杂的文档开发，你可以从 kwok 存储库 运行 make -C site serve 来运行文档的本地实例，可通过 http://localhost:1313 浏览。