文档

OpenStack 文档

文档贡献者指南 — 新手指南 — 构建文档 — 专业团队 — 文档团队办公时间

这里的重点是创建、维护和组织在 https://docs.openstack.org 站点上找到的 OpenStack 文档。虽然文档团队有助于创建一个良好的框架，但整个 OpenStack 社区——特别是像您这样的贡献者——提供了专业的文档内容和更正。

OpenStack 文档项目团队
全名	OpenStack 文档
代码名称	无
状态	相关
源代码	openstack-manuals; api-site
Bug 追踪器	http://bugs.launchpad.net/openstack-manuals 和 http://bugs.launchpad.net/openstack-api-site
Blueprints	http://blueprints.launchpad.net/openstack-manuals
贡献者文档	文档贡献者指南
当前 SIG 主席	请参阅技术写作 SIG：https://governance.openstack.org/sigs/
Meetings	文档团队会议
IRC 频道	#openstack-doc 在 OFTC 上 (关于 OpenStack 在 IRC 上的更多信息)
邮件列表	OpenStack 开发邮件列表（在主题中使用 [docs] 标签）

OpenStack 文档

已发布文档及其位置

所有文档的公共接口是 docs.openstack.org 网站。它包含持续更新的手册。如果您想编辑其中一个，请参阅 文档源和目标位置，以获取文档列表及其源代码仓库。

源代码仓库

文档源代码在 GitHub 上镜像。每个人都可以提出对文档的更改，请参阅 Documentation/HowTo。以下是构建到 docs.openstack.org 的仓库。

有关源代码仓库列表，请参阅 交付成果。

有关已发布文档的更多信息，请参阅 内容规范。

发布

列出当前开发版本和过去版本，并提供下载和发行说明的链接（每个版本的新增内容和更改，以及已知问题和潜在解决方法）

• OpenStack 发布版本

支持

如何查找或请求支持。

• 邮件列表
• OpenStack 社区问答
• Ask OpenStack

术语表

• 术语表 - 包含我们对 OpenStack、云计算和开源的定义。

项目文档

这是关于 OpenStack 的一般信息。

开发

如何向 OpenStack 贡献代码或使用 OpenStack 项目进行开发。

• Infra 手册中的开发者指南
• 如何贡献
• 签署 贡献者协议
• 设计原则
• 项目团队指南
• 编码规范
• 获取代码

Launchpad 参考

我们如何使用 Launchpad 来跟踪功能、错误和发布版本。

• Blueprints
• 错误
• Launchpad 群组

编写文档

首先，阅读 文档贡献者指南。

• 如何贡献文档
• 编写文档时要遵循的约定
• DocBook 到 RST 迁移
• DocImpact
• 故障排除文档构建
• 关于文档的评论
• Rackspace 的 Writers Guide
• 审查指南
• Mitaka 文档测试 - 安装指南和配置参考
• 如何进行文档发布
• 文档用户分析
• Documentation/PikeDocTesting

文档站点的管理员访问权限

有些区域只有受信任的基础设施或文档团队成员才能访问，才能配置或管理文档站点的一部分。示例包括

• 托管 docs.openstack.org 和 developer.openstack.org 文件的 Cloud Sites 的 FTP 凭据。
• Google 自定义搜索引擎 (CSE) 配置。
• Google Analytics 帐户信息和配置。

对于这些共享身份，我们使用以下流程来确保对授予访问权限的信息的访问权限受到限制。

• 在峰会上或另一次面对面的会议上，确保我们使用类似于 GPG 派对的 ID 验证身份。
• 在这些身份和共享信任到位后，创建一个服务器来存储帐户信息。
• 通过授予对服务器的访问权限来启用对共享帐户信息的访问。

目前，基础设施核心团队和文档 PTL 拥有 FTP 凭据的访问权限。文档 PTL 拥有 Google CSE 信息和 Google Analytics 帐户信息的访问权限。文档 PTL 可以授予对共享 Google 信息的访问权限。基础设施核心团队可以授予对 FTP 凭据的访问权限。

项目文档的 PDF - 社区目标

技术委员会冠军： Alexandra Settle (asettle)

社区目标： https://governance.openstack.org/tc/goals/train/pdf-doc-generation.html

在 Ocata 周期中，OpenStack-manuals、infra 和 translations 团队共同努力，能够从基于 rst 的指南文档生成 PDF 文档文件。此更改生成了每个 Sphinx 项目一个可下载的 PDF。这意味着从单个 Sphinx 项目构建的每个“书籍”都可以生成 PDF，从而允许希望离线查看文档的用户能够做到这一点。

这项工作在 Ocata 版本的末尾完成，但从未在项目仓库中实施。这意味着我们的用户只能下载安装指南、贡献者指南和图像指南的 PDF 文档，从而限制了我们离线用户的范围。此目标建议我们支持跨项目仓库，以进一步实现成为一个可访问的开源社区的目标。

跟踪 Etherpad： https://etherpad.openstack.org/p/train-pdf-support-goal

跟踪常见问题的 Etherpad： https://etherpad.openstack.org/p/pdf-goal-train-common-problems

故事板： https://storyboard.openstack.org/#!/story/list?tags=pdf-doc-enabled

注意：以下不再使用

全名（IRC 昵称）	项目名称	跟踪 Etherpad	测试状态
Akihiro Motoki (amotoki)	Neutron	https://etherpad.openstack.org/p/pdf-goal-train-neutron	待定
Donny Davis	Nova	https://etherpad.openstack.org/p/pdf-goal-train-nova	待定
Michael Johnson (johnsom)	Octavia	https://etherpad.openstack.org/p/pdf-goal-train-octavia	待定
Luigi Toscano (tosky)	Sahara	https://etherpad.openstack.org/p/pdf-goal-train-sahara	待定
Bogdan Dobrelya (bogdando)	TripleO	https://etherpad.openstack.org/p/pdf-goal-train-tripleo	待定

参考文献

有许多其他关于 OpenStack 的出版物来自第三方出版商。请在您最喜欢的书店网站上搜索它们。

---