我想发一封邮件讨论特定主题下所有入门文档和“文章”的增长情况。感谢大家将这些链接发送到邮件列表或在 Twitter 上分享。我们正在倾听。
文档团队一直在讨论如何确保我们帮助人们找到他们想要的内容,同时将高质量的内容纳入“官方”文档。以下是一些想法。我也想听取我们更广泛社区的意见。
我们正在做的事情
- 在文档登陆页面添加一个“从哪里开始?”部分。请查看 待处理的审核,告诉我们您对这种方法的看法。我们讨论了很多关于文档站点更友好的方法,但我还没有找到一位 Web 开发人员和设计师来重新设计,如果您感兴趣,请联系我。
- 联系作者,并在许可允许且“官方”文档尚未记录的情况下,将内容纳入官方文档。我们已经这样做过几次了,例如 如何自定义 OpenStack Dashboard。
- 将有用的博客条目链接添加到 “BloggersTips” wiki 页面。
- 扩展安装/部署指南,以包含更多发行版,以便“单发行版”指南可以独立存在。这项工作仍在 进行中。
- Hastexo 已经提出要编写一个独立的高可用性 (HA) 指南,因此我们不会再引入他们的 12.04 “all in one” 安装指南,因为 CSS OSS Starter Guide 涵盖了类似场景。
- 从 RST 文档中删除“文章”。(目前仅针对 nova,正在与项目技术负责人、QA 和 CI 团队负责人进一步讨论。)
- 将博客 URL 添加到 https://docs.openstack.org 的 Google 自定义搜索引擎。这是我从我们上次文档团队会议中采取的行动项。
我们讨论过的内容
- 删除冗余文档。在设计峰会上,nova 核心团队的成员要求从 nova 源代码仓库中删除“文章”风格的 RST 文档,创建一个更基于文档字符串的 nova.openstack.org。当被询问时,swift 核心团队的成员不想采用这种架构。我还没有专门询问所有 PTL 这个问题。因此,这里仍然存在一致性的潜在问题,即在哪里编写什么,以及拥有所有 project.openstack.org 站点,但它们实际上并没有紧密联系在一起。我目前还没有提出好的解决方案,但我们知道我们正在考虑这个问题。一个想法是让希望编写的开发人员编写 WordPress “文章”,并将它们聚合在一起,但我们还没有找到理想的实现方法(设计很好,但缺少可用的代码)。
- 为文档设置一个单独的 WordPress 博客。显然,聚合工具无法为我们提供版本标签、一次引入一个博客条目(需要 RSS 源)等所有要求。
- 设置一个“支持知识库”文章站点,例如 http://support.mozilla.org。我们在上次文档团队会议上讨论过这个问题。这似乎可以解决我们遇到的很多问题,但我的当前想法(当然可能会改变)是,支持知识库是用于故障排除文章的,而“官方”文档应该创建一个快乐路径。这两种场景不同,而且我确信文档团队目前无法用我们的现有资源承担支持场景。一个内置翻译的支持知识库将大大有助于支持我们不断增长的用户群,这对我来说很重要,但目前不在Folsom 计划中。
我会跟进每个 PTL 的文档字符串讨论,并欢迎所有意见。感谢您阅读到这里,感谢您对文档的贡献。现在开始吧!













