Contribuer à la documentation¶
La présente documentation est une ressource fondamentale pour le développement du site. Elle peut nécessiter des mises à jour et c’est pourquoi cette page vous explique comment y apporter des modifications.
Les fichiers servant à générer la documentation Sphinx sont situés dans le dossier docs/ du dépôt.
Environnement¶
Pour écrire de la documentation confortablement, on conseille d’activer le serveur de documentation. Pour ce faire, placez-vous dans le dossier docs/ et utilisez :
(env) docs $ make livehtml
Vous devriez alors pouvoir accéder à la documentation à l’adresse http://localhost:8000.
Vous pouvez maintenant apporter des modifications aux différements documents. Chaque fois que vous sauvegardez un document, le serveur va automatiquement reconstruire la documentation et rafraîchir la page web le cas échant. Pratique !
À propos de reStructuredText¶
La documentation étant générée avec Sphinx, les documents sont écrits avec reStructuredText. Il s’agit d’un langage de balisage léger assez bien adapté à la documentation technique (il est plus complet que Markdown). Les documents reStructuredText (et donc ceux de cette doc) ont l’extension .rst.
Pour une introduction au reStructuredText, voir le reStructuredText Primer de la documentation de Sphinx, ou encore la RST Cheat Sheet.
Todos¶
Les éléments restant à documenter ou incompléments sont signalés par une note « À faire ». Ces todos sont automatiquement recensés dans la liste ci-dessous. Vous pouvez insérer un nouveau todo avec la directive .. todo:: Voici une tâche à réaliser....
Si vous souhaitez contribuer à la documentation, le plus simple est de choisir l’un de ces todo et de le compléter ! :)
À faire
Liste des contributeurs avec prénom, nom, promo, adresse mail non-étudiante
(l'entrée originale se trouve dans /home/docs/checkouts/readthedocs.org/user_builds/oser-tech-docs/checkouts/latest/docs/AUTHORS.rst, à la ligne 5)
À faire
Screenshots de l’administration du site
(l'entrée originale se trouve dans /home/docs/checkouts/readthedocs.org/user_builds/oser-tech-docs/checkouts/latest/docs/guide-admin/gestion-utilisateurs.rst, à la ligne 20)
À faire
Documenter les étapes de téléchargement de la BDD des utilisateurs
(l'entrée originale se trouve dans /home/docs/checkouts/readthedocs.org/user_builds/oser-tech-docs/checkouts/latest/docs/guide-admin/gestion-utilisateurs.rst, à la ligne 32)
À faire
Documenter les étapes de modiication d’adresse email d’un utilisateur
(l'entrée originale se trouve dans /home/docs/checkouts/readthedocs.org/user_builds/oser-tech-docs/checkouts/latest/docs/guide-admin/gestion-utilisateurs.rst, à la ligne 50)
À faire
Documenter les étapes de réinitialisation d’un mot de passe
(l'entrée originale se trouve dans /home/docs/checkouts/readthedocs.org/user_builds/oser-tech-docs/checkouts/latest/docs/guide-admin/gestion-utilisateurs.rst, à la ligne 63)
À faire
Screenshots, valeur de N, valeur de M, étapes
(l'entrée originale se trouve dans /home/docs/checkouts/readthedocs.org/user_builds/oser-tech-docs/checkouts/latest/docs/guide-admin/gestion-utilisateurs.rst, à la ligne 79)
À faire
Documenter la procédure de désactivation d’un utilisateur
(l'entrée originale se trouve dans /home/docs/checkouts/readthedocs.org/user_builds/oser-tech-docs/checkouts/latest/docs/guide-admin/gestion-utilisateurs.rst, à la ligne 84)
À faire
Documenter la procédure de suppression d’un utilisateur
(l'entrée originale se trouve dans /home/docs/checkouts/readthedocs.org/user_builds/oser-tech-docs/checkouts/latest/docs/guide-admin/gestion-utilisateurs.rst, à la ligne 92)
À faire
Guide d’utilisation et de maintenance de populatedb.
(l'entrée originale se trouve dans /home/docs/checkouts/readthedocs.org/user_builds/oser-tech-docs/checkouts/latest/docs/guide-developpeur/installation.rst, à la ligne 91)