创建操作指南

日期:

2016-12-19 17:00

标签:

文档, 操作

蓝图：创建 OpenStack-Ansible 操作指南 * https://blueprints.launchpad.net/openstack-ansible/+spec/create-ops-guide

本规范建议为 Ocata 版本开发 OpenStack-Ansible 操作指南。

问题描述

在 Newton 开发周期中，安装指南经过修订，重点提供了一种为测试环境和生产环境安装 OpenStack 的方法。如 安装指南规范 中所述，操作内容不属于安装指南，因为它降低了用户安装 OpenStack 的关注度，并暂时迁移到以下开发者文档页面

需要开发一个独立的 OpenStack-Ansible 操作指南，以满足操作员使用 OpenStack-Ansible 管理和配置 OpenStack 云的信息需求。

提议的变更

操作指南的主要重点是重新组织当前内容并开发新内容，以便 OpenStack 操作员可以轻松搜索有关维护其环境、故障排除和解决问题的信息。

拟议的更改是

  • 一份新的目录，并征求开发人员和操作员的意见：https://review.openstack.org/#/c/409854/

  • 删除 OpenStack 手册操作指南中的重复内容（以便本指南主要关注 OpenStack-Ansible 操作）。

  • 将指南结构化为“运行手册”格式，原因如下

    1. 确保指南包含针对任何开始操作自己云的人员的低级操作方法。

    2. 确保指南包含针对更有经验的操作员的高级故障排除信息。

    3. 其结构旨在方便操作员找到他们正在寻找的信息。

  • 审查和更新当前操作内容，以遵循 openstack-manuals 文档约定。

备选方案

  • 当前操作内容和任何未来的内容将保留在开发者文档中。

Playbook/Role 影响

N/A

升级影响

N/A

安全影响

N/A

性能影响

N/A

最终用户影响

这些更改将改善最终用户体验，通过提供更结构化和更好的信息流程来操作您的 OpenStack 云。

部署者影响

N/A

开发人员影响

N/A

依赖项

N/A

实现

负责人

主要负责人

Alexandra Settle (asettle)

其他贡献者

Andy McCrae (andymccr), OpenStack-Ansible PTL Darren Chan (darrenc) Robb Romans (rromans)

工作项

  • 明确并获得对内容结构的共识

  • 根据需要从主题专家处收集信息

  • 创建操作指南更改的草稿目录

  • 创建工作项列表并分配资源

  • 确保文档符合 openstack-manuals 写作约定

  • 在发布前测试草稿文档

测试

测试将由社区在提供草稿后进行。将要求 OpenStack-Ansible 用户利用新的操作指南来执行 OpenStack 操作，并评估所提供的信息是否准确、清晰和简洁。

文档影响

这是一个文档更改，不适用。

参考资料