git - 在哪里放置与多个 git repos 相关的文档

Question

我有一个项目，其中包括 4 个分支 repo 协议(protocol)。我将它们分开，因为它们做的事情完全不同，但在整个项目中协同工作。

这个项目需要所有的 repos，我想把所有的文档放在一个地方，这样人们就可以在一个地方进行修改和配置说明，尤其是那些影响多个 repo 的配置选项(比如在核心应用。

那么将文档的单点放在哪里是最佳实践？我们应该把它放在一个项目上，然后从其他项目链接到它，还是有一些“git”方式来处理这个问题？

Answer 1

技术文档本身受版本控制和源代码控制。我建议为它创建一个单独的存储库。它稍后可以作为子模块包含在 4 个项目中的每一个中。

这是 Jetbrains 的此类文档 repo 示例:https://github.com/JetBrains/intellij-sdk-docs

此外，如果您计划使用 GitHub wiki 页面 - 它们存储在 stash 的存储库中。可以克隆它并用它做所有其他 git 事情。