跳转到: 导航, 搜索

文档/指南

时机:何时

对于当前项目,持续更新文档。 最好为每个蓝图或添加的功能提供文档补丁。

对于新项目,文档可以在项目获得 TC 批准并移动到 OpenStack git 命名空间后发布到 docs.openstack.org。

评审:谁

中央文档团队必须批准发布与多个项目相关的某些中央指南。 安装指南、配置指南(高可用性、安全性)、API 参考、管理员指南、运维指南。 所有这些类型的指南都属于该类别。

文档核心并不总是评审发布到

  • docs.openstack.org/developer/<projectname> 的内容。

但他们会评审列出它们的索引页面

  • docs.openstack.org/index.html
  • docs.openstack.org/developer/openstack-projects.html
  • docs.openstack.org/developer/language-bindings.html

文档核心成员评审

  • docs.openstack.org/admin-guide-cloud/
  • docs.openstack.org/openstack-ops/
  • docs.openstack.org/image-guide/
  • docs.openstack.org/cli-reference/
  • docs.openstack.org/hot-reference/

已经建立了专门的文档团队来评审

  • docs.openstack.org/security-guide/
  • docs.openstack.org/high-availability-guide/
  • docs.openstack.org/networking-guide/
  • docs.openstack.org/user-guide-admin/
  • docs.openstack.org/user-guide/
  • docs.openstack.org/kilo/install-guide/**
  • docs.openstack.org/kilo/config-reference/

编写:谁

项目应寻找愿意遵循文档团队维护的一系列规范的编写者和开发人员。 这些规范可在 OpenStack wiki 的 文档/规范 上找到。

自动化:谁

目前 Andreas 设法维护了我们构建的大部分自动化,并得到了 Christian Berendt、Anne Gentle 和 Gauvain Pocentek 的帮助。

内容:什么

如果您对写什么有疑问,文档团队很乐意提供帮助。 通常,我们会考虑受众(例如,云管理员、运维人员或使用 OpenStack 云的应用程序开发人员)以及他们想要完成的任务(例如,配置外部网络或启动实例)。

内容:哪里

请参阅 文档/内容规范 页面以确定文档的发布位置。 我们的所有文档都以署名共享为目的进行许可,因此您可以采用文档内容并对其进行重新利用,只要您仅在品牌指南到位的情况下使用 OpenStack 徽标即可。 如果您有任何疑问,请参阅 openstack.org/brand。