La documentation de ZdS

RTFM !!

L'auteur de ce sujet a trouvé une solution à son problème.
Auteur du sujet

Salut les gens,

Si on suis un peu ce qui c'est passé ces derniers temps, lors de la réunion des dévellopeurs back, on a émis l'idée de créer et de maintenir une documentation du site plus complète que celle qui existait à ce jour. Récemment, ça a été mis en place par Firm1 à l'aide de sphinx, qui nous donne même, par une seconde PR la possibilité de la consulter sur un dépôt externe.

Étant plutôt fan du format de celle-ci, j'ai une proposition à faire : puisque actuellement, cette documentation fait, en partie, doublon sur le point de l'installation avec la documentation déjà écrite, ma proposition est de réduire au maximum la documentation sur github et de pointer sur ce nouveau système (donc ne garder que le readme et transférer la partie sur le déploiement et sur gulp vers sphinx).

Attention que le choix n'est pas si anodin que ça : la rédaction de cette nouvelle documentation n'est cette fois plus en markdown mais dans le format RST (format qui est de toute façon compris en grande partie par GitHub).

J'attend vos avis :)

Édité par Alex-D

Doctorant et assistant en chimie à l'Université de NamurEx-dev' pour ZdS (a aidé à réaliser la ZEP-12 !) • Carniste cis (y parait que c'est une injure)

+1 -0
Staff

Par contre, pourquoi ne pas avoir mis les instructions de deploy… etc dans les sources rst (et du coup ne aps avoir fait abstraction du dossier sphinx) ?

Parce qu'ils sont au format markdown et melanger des fichiers md avec des fichiers rst, je ne pense pas que ce soit la meilleure chose à faire.

C'est donc tout l'objet de ce topic, virer tous les fichiers de doc en markdown et ne garder que les RsT. Donc dès que c'est validé ici, il suffit de crée l'issue qui va bien, et ça sera pris en compte. En attendant le besoin d'une doc commençant a devenir urgent (parce qu'on en a besoin pour autre chose que les instructions d'install), j'ai fait un duplicata de certains MD vers du RsT.

En gros, une fois que ce sera proprement migré en MD, on pourra donc rabattre tout le dossier sphinx vers le dossier doc ?

Je vais pas ouvrir un dossier pour ça, mais ça semble être l'action la plus naturelle…

"Meh." Outil de diff PHP : Totem

+0 -0
Vous devez être connecté pour pouvoir poster un message.
Connexion

Pas encore inscrit ?

Créez un compte en une minute pour profiter pleinement de toutes les fonctionnalités de Zeste de Savoir. Ici, tout est gratuit et sans publicité.
Créer un compte