Dokumentacja Gitlab i HTML

Question

Moje środowisko programistyczne składa się z repozytorium Git, menedżera repozytorium GitLab i Jenkins. Podczas procesu budowania tworzona jest dokumentacja z Doxygen w formacie HTML.

Czy można przechowywać tę dokumentację na wiki projektu GitLab? Wiem, że HTML nie jest obsługiwany w Gollumie, który jest silnikiem wiki Gitlaba. Konwersja HTML na Markdown nie jest zadowalająca z powodu wewnętrznych linków w plikach HTML, które wskazują na inne pliki HTML.

Czy powinienem przechowywać dokumentację w oddzielnej wiki i zamiast tego przypisywać link do wiki projektu GitLab?

Answer 1

Domyślam się, że odpowiedź zależy od tego, do czego używasz dokumentacji HTML i jak ją rozpowszechniasz.

Po pierwsze, której wersji Gitlab używasz?

1. Jeśli jest tylko dla programiści, aby uzyskać dostęp do (aka są dokumenty prywatne), a następnie na Gitlab >= 8.1.2 nie jest usługą o nazwie External Wiki, który pozwala zastąpić link do projektu Wiki przez dowolny adres URL Twój wybór. Po prostu skonfiguruj serwer WWW obsługujący dokumentację HTML, niech twój serwer budujący prześle najnowszą wersję po każdej kompilacji i zadzwoń do niej jeden dzień.

2. Jeśli dokumentacja jest kodem, który chcesz kontrolować i rozpowszechniać w wersji, zrób to.

Czy iść na 1. lub 2., nadal jest to dobry pomysł, aby mieć całą dokumentację w oddzielnym git repozytorium, ponieważ można uzyskać kompresję za darmo i za pomocą git pull jest znacznie lepsza niż jakikolwiek rsync do synchronizacji dowolnych katalogów lokalnych lub zdalnych. To tylko kwestia ustawienia skryptu shell lub git hooks, aby automatycznie zrobić to wszystko dla ciebie; albo w czasie zatwierdzania lub budowania.

Mam nadzieję, że to pomoże!