为什么我应该将我的 Wiki 存储在单独的存储库中?
Why should I store my Wiki in a separate Repository?
我在 bitbucket.org 上托管了一个私人 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.
但是,不幸的是,这对我来说没有任何意义。
每当我更新我的源代码时,在大多数情况下我还必须更新文档。当我在处理我的源代码的旧版本时,或者在另一个分支中,未来的 wiki 将包含文档,这在当前状态下没有实现。
为什么不只在我的源代码存储库中创建一个名为 "Documentation" 的文件夹?因此文档将始终与当前源保持同步 code/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 更改(可能有很多更改,可能是由非技术用户进行的)会创建在您的项目历史中提交。这通常是不可取的,因为它会分散代码提交的注意力,使合并复杂化等。
如果你想在你的存储库中有一个类似 wiki 的目录,没有什么能阻止你:
+ Documentation/
|--- index.md
`--- other-file.md
当然,对此目录的更改可以与代码更改同步。
还有其他有趣的方法。
例如,在 GitHub 上,您可以 create a website from a branch gh-pages
在您的存储库中。每次您更新分支时,该网站都会自动更新,让您的网站与您的代码保持一定程度的同步,并为您提供格式良好的输出,并保持完全断开连接的方法的灵活性。
使用适合您的任何东西。
我在 bitbucket.org 上托管了一个私人 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.
但是,不幸的是,这对我来说没有任何意义。 每当我更新我的源代码时,在大多数情况下我还必须更新文档。当我在处理我的源代码的旧版本时,或者在另一个分支中,未来的 wiki 将包含文档,这在当前状态下没有实现。
为什么不只在我的源代码存储库中创建一个名为 "Documentation" 的文件夹?因此文档将始终与当前源保持同步 code/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 更改(可能有很多更改,可能是由非技术用户进行的)会创建在您的项目历史中提交。这通常是不可取的,因为它会分散代码提交的注意力,使合并复杂化等。
如果你想在你的存储库中有一个类似 wiki 的目录,没有什么能阻止你:
+ Documentation/
|--- index.md
`--- other-file.md
当然,对此目录的更改可以与代码更改同步。
还有其他有趣的方法。
例如,在 GitHub 上,您可以 create a website from a branch gh-pages
在您的存储库中。每次您更新分支时,该网站都会自动更新,让您的网站与您的代码保持一定程度的同步,并为您提供格式良好的输出,并保持完全断开连接的方法的灵活性。
使用适合您的任何东西。