git - 为什么我应该将我的 Wiki 存储在单独的存储库中?

标签 git documentation bitbucket wiki

<分区>

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

The wiki itself is actually a git repository, which means you can clone it, edit it locally/offline, add images or any other file type, and push it back to us. It will be live immediately.

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

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

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

最佳答案

Aren't these wikis designed for documentation and should only be used as a simple replacement for a general projects homepage? For example: Info's about the developers, the projects history, it's purposed targets, and so on.

不一定。正如评论者在上面指出的那样,此类 wiki 有许多可能的用途。

将 wiki 作为存储库的一部分的一个很好的理由是,任何 wiki 更改(可能有很多更改,可能是由非技术用户进行的)都会在您的项目历史记录中创建提交.这通常是不可取的,因为它会分散代码提交的注意力,使 merge 复杂化等。

如果你想在你的存储库中有一个类似 wiki 的目录,没有什么能阻止你:

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

当然,对该目录的更改可以与代码更改同步。

还有其他有趣的方法。

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

使用适合您的任何东西。

关于git - 为什么我应该将我的 Wiki 存储在单独的存储库中?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/28503249/

相关文章:

java - Netbeans 8.0.1 - 远程存储库包含未 merge 到本地分支的提交

linux - gnutls_handshake() 失败 : Handshake failed GIT

git - 在 GitHub 中 merge 分支

node.js - 我有一个被忽略的文件夹,但每当我将 'git status' 作为未跟踪文件执行时,它仍然显示

c# - 您应该为接口(interface)、具体实现或两者编写 XML 注释吗?

Java JAXB 的优点/缺点和文档

ssh - BitBucket Pipeline ssh 到 Digital Ocean 权限被拒绝(公钥)

Git master 分支作为 live 版本的理解

c - 扫描代码注释并转换为标准格式的工具

git - 从 BitBucket 下载并 merge 文件