diff --git a/content/zh/blog/_posts/2019-10-29-2019-sig-docs-survey.md b/content/zh/blog/_posts/2019-10-29-2019-sig-docs-survey.md index 3fc5bfa360..841674b534 100644 --- a/content/zh/blog/_posts/2019-10-29-2019-sig-docs-survey.md +++ b/content/zh/blog/_posts/2019-10-29-2019-sig-docs-survey.md @@ -1,6 +1,6 @@ --- layout: blog -title: "Kubernetes 文献调查" +title: "Kubernetes 文档最终用户调研" date: 2019-10-29 slug: kubernetes-documentation-end-user-survey --- @@ -20,7 +20,7 @@ In September, SIG Docs conducted its first survey about the [Kubernetes documentation](https://kubernetes.io/docs/). We'd like to thank the CNCF's Kim McMahon for helping us create the survey and access the results. --> -9月,SIG Docs 进行了第一次关于 [Kubernetes 调查文件](https://kubernetes.io/docs/) 。我们要感谢 CNCF +9月,SIG Docs 进行了第一次关于 [Kubernetes 文档](https://kubernetes.io/docs/) 。我们要感谢 CNCF 的 Kim McMahon 帮助我们创建调查并获取结果。 -```text -- ...但既然我们谈论的是文档,多多益善。更多的高级配置示例对我来说将是最好的选择。比如每个配置主题的用例页面,从初学者到高级示例场景。像这样的东西真的是令人惊叹...... - -- 更深入的例子和用例将是很好的。我经常感觉 Kubernetes 文档只是触及了一个主题的表面,这可能对新用户很好,但是它没有让更有经验的用户获取多少关于如何实现某些东西的“官方”指导。 - -- 资源节(特别是 secrets)希望有更多类似于产品的示例或指向类似产品的示例的链接 - -- 如果能像很多其它技术项目那样有非常清晰的“快速启动” 逐步教学完成搭建就更好了。 - 现有的快速入门内容屈指可数,也没有统一的指南。结果是信息泛滥。 + +```text +- ...但既然我们谈论的是文档,多多益善。更多的高级配置示例对我来说将是最好的选择。比如每个配置主题的用例页面, +从初学者到高级示例场景。像这样的东西真的是令人惊叹...... +- 更深入的例子和用例将是很好的。我经常感觉 Kubernetes 文档只是触及了一个主题的表面,这可能对新用户很好, +但是它没有让更有经验的用户获取多少关于如何实现某些东西的“官方”指导。 +- 资源节(特别是 secrets)希望有更多类似于产品的示例或指向类似产品的示例的链接 +- 如果能像很多其它技术项目那样有非常清晰的“快速启动” 逐步教学完成搭建就更好了。现有的快速入门内容屈指可数, +也没有统一的指南。结果是信息泛滥。 ``` -少数受访者提供的技术建议: -```text -- 使用 ReactJS 或者 Angular component 使表的列可排序和可筛选。 - -- 对于大多数人来说,我认为用 Hugo - 一个静态站点生成系统 - 创建文档是不合适的。有更好的系统来记录大型软件项目。 - -具体来说,我希望看到 k8s 切换到 Sphinx 来获取文档。Sphinx 有一个很好的内置搜索。 -如果你了解 markdown,学习起来也很容易。 + +少数受访者提供的技术建议: +```text +- 使用 ReactJS 或者 Angular component 使表的列可排序和可筛选。 +- 对于大多数人来说,我认为用 Hugo - 一个静态站点生成系统 - 创建文档是不合适的。有更好的系统来记录大型软件项目。 +具体来说,我希望看到 k8s 切换到 Sphinx 来获取文档。Sphinx 有一个很好的内置搜索。如果你了解 markdown,学习起来也很容易。 Sphinx 被其他项目广泛采用(例如,在 readthedocs.io、linux kernel、docs.python.org 等等)。 ```