分布式组件版本

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

什么是分布式组件版本

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

分布式组件版本的一个常见用例是,它的大部分源文件存储在一个存储库中,但是一些示例(示例族目录)和教程(页面族目录)存储在由培训团队管理的另一个存储库中。Antora 可以将两个存储位置的源文件合并为单个组件版本。该功能由简单但非常强大的组件版本描述符文件 antora.yml 提供。

管理 antora.yml 文件和键

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

当组件版本的源文件是分布式时,只有一个 antora.yml 文件应该指定可选配置键,如标题(title)和导航(nav),以及必需的组件名称(name)和版本(version)。所有其他标记组件版本源文件位置的 antora.yml 文件必须只指定组件名称和版本。冲突或重复的可选配置键可能会产生不可预测的结果。

管理模块和文件

如果 Antora 在分布式组件版本中找到两个或多个具有相同文件名的源文件,并且它们属于相同的族和模块,则会失败并报错。如果 Antora 发现一个模块有两个或多个具有相同文件名的导航文件,也会发生这种情况。