更好地在存储库之间共享词汇表

在仓库之间更好地共享术语表

https://blueprints.launchpad.net/openstack-manuals/+spec/common-glossary-setup

问题描述

security-doc、operations-guide 和 openstack-manuals 仓库共享术语表。未来 training-guides 仓库也可能使用它。我们应该只在一个地方维护它。

同样,翻译也应该只在一个地方进行。目前,翻译发生在这些仓库中的任何一个:在 openstack-manuals 中使用单独的 POT 文件,在 security-doc 和 operations-guide 中作为书籍的一部分。

目前,术语表在必要时手动导入到 operations-guide 和 security-doc 仓库中。operations-guide 甚至包含与 openstack-manuals 仓库中的版本略有不同的标题。

术语表需要在构建时提供给 maven,以确保所有链接都能正确工作。

提议的变更

我们应该继续拥有一个主源术语表。

openstack-manuals 仓库应该继续作为主源。

一旦主源中的术语表发生更改,它将通过 Jenkins 作业建议给其他仓库。

备选方案

  • 使用单独的术语表仓库并在其他仓库中使用 git 子模块。我们当前的 gerrit 设置不允许使用 git 子模块,因此在当前基础设施下这是不可行的。
  • 另一种选择是在构建时将包含术语表及其翻译的仓库检出到已知位置。这个选项要求每个贡献者在本地构建时都必须拥有术语表,这可能对贡献者来说要求过高。
  • 另一种替代方案可能是创建一个新的 openstack/glossary 仓库并始终从那里复制,而不是让 openstack/openstack-manuals/doc/glossary 作为存储位置。将级别提高到仓库可能会有助于获得更多对术语表的贡献。

实现

负责人

Andreas Jaeger (jaegerandi)

工作项

  • 根据需要移动文件。
  • 手动测试安全指南和操作指南的解决方案。
  • 根据需要更改构建作业。

依赖项

测试

参考资料

当前完整术语表构建:https://docs.openstack.org/glossary/content/glossary.html

Creative Commons Attribution 3.0 License

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

docs-specs