Forum IT Tranquillo

Ciao,
la tua documentazione è eccellente! https://www.wapt.fr/fr/doc/
Potresti dirmi cosa mi serve per implementare uno strumento simile presso il mio cliente?
Ho un server CentOS 7 e vorrei poter presentare questo tipo di documentazione al mio cliente.
È chiara, semplice e fatta molto bene!

Grazie per il tuo feedback.

Ciao,

innanzitutto grazie a nome di Tranquil IT Systems. È sempre un piacere ricevere complimenti; l'intero team si impegna a fornire una documentazione il più completa possibile.

Per quanto riguarda la documentazione stessa, la generiamo utilizzando reStructuredText, Docutils e Sphinx.

Se hai mai modificato un documento Markdown o una wiki, l'organizzazione dei titoli è abbastanza simile. La differenza principale sta nel processo di compilazione della documentazione, che ci permette di generarla in diverse lingue e formati (HTML, PDF, ePub e LaTeX).

Se desideri saperne di più su RST, Sphinx e Docutils, visita questo link: https://www.jujens.eu/posts/2014/Aug/13 ... st-sphinx/

La documentazione ufficiale è disponibile qui: http://docutils.sourceforge.net/sandbox ... rt-fr.html

Alexandre

Grazie, ho ottenuto il risultato che volevo.
Ora cercherò di capire come fare la stessa cosa manualmente, perché ` yum install` e `pip install` non sono adatti alle mie esigenze.

Preferisco mantenere il controllo su ciò che installo, in modo da poter installare ciò che voglio, dove voglio (quindi partendo dai file tar.gz).

(Per caso avresti della documentazione su come installare tutto questo dai sorgenti su CentOS?)
((Ancora meglio! Un pacchetto pronto e configurabile, che includa tutto il necessario senza dipendenze.))
(((Ehi, non lo fai per i tuoi clienti? Distribuisci questo tipo di wiki tramite Wapt alle macchine dei clienti per le loro informazioni interne. Probabilmente pochi di loro hanno intranet o wiki.)))

Per un'installazione pulita, a dire il vero non c'è molta documentazione, a parte il file setup.py del progetto Sphinx: https://github.com/sphinx-doc/sphinx/bl ... r/setup.py.

Non lo usiamo su Windows; il bot di compilazione della documentazione dal repository Git (Jenkins) usa i comandi pip per l'installazione delle dipendenze.

In bocca al lupo con RST comunque.