分布式组件版本

虽然一个组件版本的所有源文件通常存储在单个存储库中,但这并不是必需的。Antora可以从多个存储库中收集属于同一组件版本的源文件。

什么是分布式组件版本?

当一个组件版本的源文件存储在多个内容根目录(即多个存储库、多个起始页面等)中时,它被称为分布式组件版本

分布式组件版本的常见用例是,大多数源文件存储在一个存储库中,但一些示例(examples家族目录)和教程(pages家族目录)存储在由培训团队管理的另一个存储库中。Antora可以将来自两个存储位置的源文件组合成单个组件版本。这种能力是通过简单但非常强大的组件版本描述符文件antora.yml提供的。

管理antora.yml文件和键

请记住,antora.yml文件指定了组件版本的组件名称和版本。如果Antora发现两个或更多个指定相同组件名称和版本的antora.yml文件,则它认为后续标准目录集中的所有文件都属于同一组件版本,即使这些源文件是从多个位置收集的。

当组件版本的源文件分布时,只有一个antora.yml文件应该指定可选配置键,如titlenav,除了必需的组件nameversion。所有其他标记组件版本源文件位置的antora.yml文件必须只指定组件nameversion。冲突或重复的可选配置键可能会产生不可预测的结果。

冲突文件

设置分布式组件版本时,每个内容源根必须提供一组唯一的文件(除了antora.yml)。换句话说,当组合时,内容源根不能重叠。

如果Antora发现两个或更多个具有相同资源ID的源文件,它将失败并显示错误。这些是属于分布式组件版本中相同家族和模块的相同文件名。如果Antora发现一个模块具有两个或更多个具有相同文件名的导航文件,也会发生这种情况。有关此情况的更多信息,请参阅重复资源