发布草稿手册

草稿手册的发布

https://blueprints.launchpad.net/openstack-manuals/+spec/draft-publishing

问题描述

目前,以下指南并未从 git 仓库的主分支发布:

  • 网络指南
  • 安装指南
  • RST 用户指南(在我们讨论此规范时会更改)

这使得贡献者难以审查当前状态。

我们将配置参考发布到 https://docs.openstack.org/trunk/

我们还有一个 trunk 索引页面,它谈论“草稿”指南,但也引用了持续发布的指南,这可能会让用户感到困惑。

另一个挑战是翻译指南的草稿。目前,我们不区分完全翻译的指南和草稿,唯一的区别是索引页面中的一个链接。

提议的变更

  1. 将草稿内容发布到特殊位置,例如 /draft/
  2. 创建一个单独的页面,引用所有草稿文档,并且仅引用这些文档,此页面应被隐藏。该页面为 /draft/draft-index.html
  3. 删除当前的 /trunk/index.html 页面及其链接。
  4. 确保搜索引擎不会索引这些页面。
  5. 确保任何部分翻译的页面不会发布到 /lang/trunk/,而是发布到 /lang/draft

对于翻译内容

  1. 将草稿翻译内容发布到 /draft/LANG/
  2. 将指南添加到 /draft/draft-index.html 索引页面。
  3. 一旦指南被审查并完全翻译,将内容移动到 /LANG/ 并从公共的语言特定索引页面引用它。

备选方案

  1. 保持现状
  2. 发布到另一个位置,例如 /trunk/

实现

  • 更改发布位置。
  • 删除 /trunk/index.html 及其链接。
  • /draft/ 添加到 robots.txt
  • 创建新的 /draft/draft-index.html 页面。
  • 审查翻译文档并将草稿翻译文档发布到 /draft/LANG/ 并添加链接到 /draft/draft-index.html
  • 删除旧页面。
  • 重新生成站点地图。

负责人

jaegerandi

工作项

参见实现。

依赖项

无。

测试

  • 通过访问 /trunk 并确保重定向到位来测试。
  • 搜索草稿内容,确保未找到它。
Creative Commons Attribution 3.0 License

除非另有说明,本文档根据 知识共享署名 3.0 许可协议 授权。请参阅所有 OpenStack 法律文件

docs-specs