Gitlab和HTML文档

时间:2015-04-30 11:16:14

标签: jenkins doxygen gitlab

我的开发环境包括Git存储库,GitLab存储库管理器和Jenkins。在构建过程中,使用HTML格式的Doxygen生成文档。

是否可以将该文档存储在GitLab项目的wiki上?我知道Gollum不支持HTML,这是Gitlab的wiki引擎。由于HTML文件中指向其他HTML文件的内部链接,将HTML转换为Markdown并不令人满意。

我应该将文档存储在单独的wiki中,而只提交指向GitLab项目wiki的链接吗?

1 个答案:

答案 0 :(得分:2)

我想答案取决于您使用HTML文档的内容以及分发的数量。

首先,您使用的是哪个版本的Gitlab

  1. 如果仅供您的开发人员访问(也就是这些是私人文档),那么在Gitlab >= 8.1.2上有一个名为External Wiki的服务允许您替换Wiki 1}}项目的链接由您选择的任何URL。只需设置一个服务于html文档的Web服务器,让构建服务器在每次构建后上传最新版本,并在一天内调用它。

  2. 如果您的文档是要进行版本控制和分发的代码,请执行此操作。

  3. 无论你选择1.还是2.,将整个文档放在一个单独的git存储库中仍然是一个好主意,因为你可以免费获得压缩并使用git pull很多比使用任何rsync同步任何本地或远程目录更好。然后只需设置shell脚本或git hooks即可自动为您完成所有操作;无论是在提交还是构建时。

    希望这有帮助!