Blueprint-restructure-documentation

旧设计页面 此页面用于帮助设计已实现的功能。因此，此页面可能不会更新，并且可能包含过时的信息。上次更新时间为 2014-05-15

• Launchpad Entry: restructure-documentation
• Created: Tom Fifield
• Contributors: Diane Fleming

总结

OpenStack 文档库是在几年前设计的。

从那时起，该库在没有特定组织的情况下不断增长。同时，文档贡献者也了解了用户如何与其交互。

此蓝图描述了一个重构 OpenStack 文档的计划，以

• 为不同的受众（部署者、用户和开发者）提供文档库的清晰路线图。
• 减少冗余。
• 提高可用性、清晰度和一致性。

受众

重构将使这些受众能够使用以下文档完成任务

受众	タスク	文档
OpenStack 部署者	安装、配置和运行 OpenStack 集群。	OpenStack 安装指南 OpenStack 操作指南 OpenStack 配置参考 OpenStack 云管理员指南
OpenStack 最终用户和管理员	通过以下方式在 OpenStack 云中执行任务 Horizon 仪表板 OpenStack 命令行客户端 直接通过 OpenStack APIs - 请参阅“OpenStack API 指南”	OpenStack 终端用户指南 OpenStack 管理员用户指南
OpenStack 贡献者和应用程序开发者	扩展 OpenStack APIs。 编写在 OpenStack 云之上运行的应用程序。	OpenStack API 指南 OpenStack API 完整参考 网页 - 每个 OpenStack 项目一个页面

交付成果 - 部署者

受众: 希望安装、配置和运行 OpenStack 集群的部署者。
产品信息: Havana, 2013.1
包含通用词汇表？ 是

OpenStack 安装指南

蓝图:Install-with-multiple-architectures

目的

• 为部署者提供有关如何安装、配置和运行 OpenStack 集群的分步说明。
• 包含易于遵循、轻量级、逐条命令的步骤，用于安装具有定义架构的 OpenStack 集群。
• 包含命令步骤的基本解释性文本，使首次使用的用户能够理解他们正在执行的操作的原因。
• 介绍 OpenStack 社区，包括如何获取帮助。
• 排除不寻常的部署场景。
  
  

资料来源

• OpenStack 基本安装指南 - Ubuntu 12.04
• OpenStack 基本安装指南 - Fedora 18
• OpenStack 安装和部署手册 - Ubuntu
• OpenStack 安装和部署手册 - Red Hat
• OpenStack <项目> 管理指南/s
• 项目 devref/s

OpenStack 操作指南

目的

• 为部署者提供有关如何设计、设置和运行 OpenStack 集群的明确指导。
• 包含当前在OpenStack 高可用性指南中的信息。
• 排除安装说明和配置参考信息。
  
  

资料来源

• OpenStack 操作指南
• OpenStack 高可用性指南?? 或者这是否保持在自己的书籍中？
• OpenStack 项目 管理指南/s
• 项目 devref/s

OpenStack 配置参考

目的

• 列出 OpenStack 可用的配置选项。使用自动生成从代码生成选项。
• 包含配置文件、每个文件中的配置选项、配置扩展以及每个配置功能的用例。
• 排除 API 参数。
  
  

资料来源

• OpenStack 项目 管理指南/s
• 项目 devref/s

OpenStack 云管理员指南

目的

• 为日常云管理员提供有关如何执行管理任务的指导。
  
  

资料来源

• OpenStack 项目 管理指南/s
• 项目 devref/s

蓝图: 蓝图 - OpenStack 管理指南, 蓝图 - 模块化 OpenStack 管理指南,

交付成果 - 管理员和最终用户

受众:

• 使用 Horizon 仪表板或 OpenStack 命令行客户端在 OpenStack 云中执行任务的用户。
• 希望通过使用 OpenStack APIs 开发在 OpenStack 之上运行的应用程序的入门级应用程序开发者。

路线图:

• 用户通过使用 Horizon 仪表板和 OpenStack 命令行客户端来了解云计算。
• 然后，他们使用 OpenStack APIs 创建可扩展的应用程序。

产品信息: Havana, 2013.1

包含通用词汇表？ 是

蓝图: 蓝图 - OpenStack 用户文档

OpenStack 最终用户指南 (新)

请参阅 蓝图 以获取详细信息。

OpenStack 管理员用户指南 (新)

请参阅 蓝图 以获取详细信息。

交付成果 - 应用程序开发者和 OpenStack 贡献者

受众: 希望扩展 OpenStack APIs 或使用 OpenStack APIs 编写应用程序的开发者。

发布信息: API vn

包含通用词汇表？ 是

策略

1. 删除现有的 API 参考。
2. 添加一个 API 指南，描述 API 概念、常规信息以及访问 API 的方法。
3. 将当前在 API 参考/s 中的材料移动到 WADL 文件中，以生成 API 完整参考页面。每个 OpenStack 项目一个网页。尽可能从 nova 代码库中获取源代码示例。
   

最终结果：每个项目一个 API 参考页面，一个 API 指南。

蓝图: 蓝图 - OpenStack API 文档

OpenStack API 指南 (新)

请参阅 蓝图 以获取详细信息。

OpenStack 项目 API 参考/s (删除)

请参阅 蓝图 以获取详细信息。

OpenStack API 完整参考 (多个网页)

请参阅 蓝图 以获取详细信息。