Migrazione della documentazione di FusionDirectory

readthedocs fusiondirectory

All’inizio del progetto FusionDirectory, abbiamo scelto ciò che era più semplice per noi e ciò che tutti conoscevano, 5 anni fa la scelta era ovvia di usare un wiki.

Man mano che il progetto cresceva, abbiamo cercato di costruire la nostra documentazione in diverse lingue e, naturalmente, non è riuscita perché è molto difficile sincronizzare la documentazione in varie lingue.

Man mano che il progetto cresce, acquista popolarità e viene utilizzato in molti contesti produttivi come centri di ricerca, istituzioni pubbliche, istituti, operatori di telecomunicazioni e partiti politici, quindi il wiki si è rivelato difficile da mantenere e allo stesso tempo tempo incapace di fornire la documentazione nei vari formati richiesti dai clienti.

Cercavamo quindi una soluzione per creare facilmente la documentazione e pubblicarla immediatamente in html, pdf epub, ed abbiamo trovato alcune soluzioni:

  • asciidoc
  • docbook
  • sphinx

Dopo alcuni test e per la facilità d’uso e la possibilità di pubblicare la documentazione online su Read The Docs integrata nel nostro gitlab tramite hook.

Ora abbiamo buona documentazione per gli sviluppatori e per gli utenti che viene aggiornata automaticamente ogni volta che apportiamo una correzione.