为什么我要将Wiki存储在单独的存储库中?

时间:2015-02-13 15:42:33

标签: git documentation bitbucket wiki

我在bitbucket.org上托管了一个私有git存储库。 还有一个单独的wiki存储库自动创建:

  

wiki本身实际上是一个git存储库,这意味着你可以   克隆它,在本地/离线编辑它,添加图像或任何其他文件类型,   然后把它推回给我们。它将立即生效。

但不幸的是,这对我没有任何意义。 每当我更新源代码时,在大多数情况下我还必须更新文档。当我正在处理旧版本的源代码或其他分支时,未来的wiki将包含文档,这些文档在当前状态下未实现。

为什么不在我的源代码库中创建一个名为“Documentation”的文件夹?因此,文档将始终与当前源代码/ API保持同步。

这些wiki不是为文档而设计的,只能用作一般项目主页的简单替代品吗?例如:Info关于开发人员,项目历史,目标目标等等。

1 个答案:

答案 0 :(得分:4)

  

Aren这些wiki是为文档而设计的,只能用作一般项目主页的简单替代品?例如:关于开发人员的信息,项目历史,目标等等。

不一定。正如评论者指出的那样,这样的维基有很多可能的用途。

将wiki作为您的存储库的一部分的一个很好的理由是任何wiki更改(可能有很多这些,可能是非技术用户)会在您的项目中创建提交&# 39;历史。这通常是不受欢迎的,因为它会分散代码提交,会使合并变得复杂等等。

如果你想在你的资源库中有一个类似wiki的目录,没有什么可以阻止你:

+ Documentation/
|--- index.md
`--- other-file.md

此目录的更改当然可以与代码更改同步。

还有其他有趣的方法。

例如,在GitHub上,您可以在存储库中create a website from a branch gh-pages。每次更新分支时,本网站都会自动更新,让您的网站与您的代码保持一定的同步,并为您提供格式良好的输出,并保持完全断开连接方法的灵活性。

使用适合你的任何东西。