Документация Gitlab и HTML

Моя среда разработки состоит из репозитория Git, менеджера хранилища GitLab и Jenkins. Во время процесса сборки документация создается с помощью Doxygen в формате HTML.

Можно ли хранить эту документацию в вики-проекте GitLab? Я знаю, что HTML не поддерживается в Gollum, который является вики-движком Gitlab. Преобразование HTML в Markdown не является удовлетворительным из-за внутренних ссылок в файлах HTML, которые указывают на другие файлы HTML.

Должен ли я хранить документацию в отдельной вики вместо этого и только фиксировать ссылку на вики проекта GitLab?

Ответы

Ответ 1

Я думаю, что ответ зависит от того, для чего вы используете свою документацию HTML и как вы ее распространяете.

Прежде всего, какую версию Gitlab вы используете?

  • Если только ваши разработчики получат доступ (например, это частные документы), то в Gitlab >= 8.1.2 есть служба под названием External Wiki, которая позволяет вам заменить ссылку Wiki на по любым URL-адресам по вашему выбору. Просто настройте веб-сервер, обслуживающий вашу html-документацию, чтобы ваш сервер сборки загрузил самую новую версию после каждой сборки и назвал ее днем.

  • Если ваша документация - это код, который вы хотите контролировать и распределять по версии, сделайте это.

Если вы идете на 1. или 2., все же хорошая идея иметь всю документацию в отдельном репозитории git, потому что вы получаете сжатие бесплатно, а использование git pull намного лучше, чем использование каких-либо rsync для синхронизации любых локальных или удаленных каталогов. Тогда нужно только настроить shell script или git hooks, чтобы автоматически выполнить все это для вас; либо в момент фиксации или сборки.

Надеюсь, это поможет!