我应该对文档进行战略规划，好吧，我必须说我在为即将发布的 OpenStack 版本创建规范方面有些落后了。在峰会上进行了很多规范规划，但我过于专注于文档冲刺，没有为 Bexar 和 Cactus 版本制定任何具体的文档计划。我想修改一下，并从社区乃至更广泛的范围征求大家的意见。以下是一些想法，它们包含在一个 关于文档的单一蓝图中。我很乐意听取大家对这些计划和规范的反馈，我们可以在 wiki 上编辑它们。
1. 文档站点 – OpenStack 需要一个集中的 docs.openstack.org 站点，它可以从各种其他来源整理内容，并在访问时提供良好的用户体验。我的目标是在 Bexar 版本（2 月）之前实现这一点。
2. 官方文档 – OpenStack 需要一种方式来指示页面或站点为“官方 OpenStack 文档”，这意味着它尽可能准确，并且程序已经过测试。我再次将此标记为 Bexar 版本。
3. 文档版本控制 – 我们正在朝着冻结版本页面/站点迈出小步。例如，您应该能够访问 http://swift.openstack.org/1.0/ 并获得冻结在时间点上的站点，其中包含 1.0 版本的开发人员文档。我们可以在 Bexar 版本之前完成这项工作。
4. man 手册页 – 我们需要为 nova-manage、nova-compute 和 nova-networking 创建 man 手册页。nova-manage man 手册页现在包含在构建中，但需要编辑。它从 RST 文件中获取，并使用 Sphinx 文档构建。这可以在 Bexar 版本中完成。
5. 教程 – 现在我们正在进行虚拟盒子和 stack on a stick 的开发，我们需要有意义且足够简单的教程，以便逐步完成，同时仍然可以令人印象深刻地展示 OpenStack 云的强大功能。以下是一些教程的想法
- 为 WordPress 等 Web 应用程序创建一个 LAMP 堆栈 – 演示虚拟机之间的连接，描述如何随着您的博客变得越来越受欢迎而扩展（嘿，我们可以梦想，对吧？）
- 构建您自己的 CDN 来提供视频内容
- 用于 Mathematica 项目的学术计算，只需一两天时间启动 10 台机器
- 使用 AMPQ/RabbitMQ 创建新闻阅读器应用程序
我认为我们可以在 Bexar 版本之前完成一个经过测试的可靠教程，其余的则留到 Cactus 版本。大家对如何优先处理这些教程有什么想法？哪些需求最高？
6. Glance 文档 – 随着 Glance 的实现仍在 Bexar 版本中进行，我们需要计划安装和集成文档与 Bexar 版本。
请告诉我您对即将发布的版本的优先级，我们将更新 规范，以封装文档工作蓝图。文档站点是需要设计和架构的最重要项目，因此我欢迎大家的意见和想法，并特别强调“文档站点！”
发表评论