用户指南一致性编辑¶

问题描述¶

在 Mitaka 发布周期内的文档更改和重建之后，仍有一些编辑项目涉及 OpenStack 管理员指南和 OpenStack 用户指南。本规范将这些项目作为 Newton 的优先事项。它还引入了文档邮件列表或报告的错误中提出的工作项目。

提议的变更¶

编辑表格和代码片段，以确保它们在 OpenStack 管理员指南和 OpenStack 用户指南中显示一致。

使用 OpenStack 贡献者指南中的 Personae 信息，确认管理员指南中的章节以及章节内的内容对目标受众具有信息性。在适当的时候，将指南中的某些部分链接在一起：例如“有关迁移卷的更多信息，请参阅 OpenStack 用户指南”。

对信息架构进行具体调整 - 内容出现在特定章节的位置

• 网络 - 将配置身份验证的网络说明移至更前面。
• 块存储 - 持久存储需求应更早出现。
• 使用 Rootwrap 加固 - 移动并重构常见问题解答部分架构。

以及其他需要的部分。

为安全加固内容包括新的图表，特别是改进使用可信计算池的 OpenStack 第二张图表。新的图表需要标题，并与其它图表保持一致性。

在用户指南中的所有示例中，将遗留客户端命令替换为最新的 OpenStack CLI 命令。

实现¶

依赖项¶

本规范旨在作为 Newton 版本的待办事项，但是，由于时间和志愿者数量的限制，其中一些项目可能无法及时完成以供发布。

最有可能完成的优先事项是

• 表格一致性
• 图表改进
• 从遗留命令更新到 openstack 客户端命令。

测试¶

确保文档使用新的表格和图表构建成功

参考资料¶

使用 使用 OpenStack 命令替换其他命令蓝图，用户指南中遗留命令行客户端的更新工作已经开始。