Documentazione Gitlab e HTML

Question

Il mio ambiente di sviluppo è costituito da repository Git, gestore repository GitLab e Jenkins. Durante il processo di generazione viene generata una documentazione con Doxygen in formato HTML.

È possibile archiviare quella documentazione sul wiki del progetto GitLab? So che HTML non è supportato in Gollum, che è il motore wiki di Gitlab. La conversione di HTML in Markdown non è soddisfacente a causa di collegamenti interni in file HTML che puntano ad altri file HTML.

Devo archiviare invece la documentazione in un wiki separato e solo il collegamento al wiki del progetto GitLab?

Answer 1

Immagino che la risposta dipenda da cosa usi la documentazione HTML e da quanto la distribuisci.

Prima di tutto, quale versione di Gitlab stai utilizzando?

1. Se è solo per gli sviluppatori per ottenere l'accesso a (aka questi sono documenti privati), poi su Gitlab >= 8.1.2 c'è un servizio chiamato External Wiki che permette di sostituire il link Wiki del progetto da qualsiasi URL di la tua scelta. Basta configurare un server Web che serva la documentazione html, fare in modo che il server di compilazione carichi la versione più recente dopo ogni generazione e chiamarla un giorno.

2. Se la documentazione è un codice che si desidera controllare e distribuire versione, eseguire tale operazione.

Se si va per 1 o 2., è ancora una buona idea avere un tutta la documentazione in un repository separata git, perché si ottiene la compressione gratuitamente e utilizzare git pull è molto meglio che con qualsiasi rsync per sincronizzare qualsiasi directory locale o remota. Quindi è solo questione di impostare lo script shell o git hooks per eseguire automaticamente tutto questo per te; o al momento del commit o del tempo di costruzione.

Spero che questo aiuti!