La documentation officielle¶
Les documentations officielles sont disponibles aux adresses suivantes :
Accès direct au répertoire contenant la documentation : http://eole.orion.education.fr/documentations
La documentation non officielle (contributive)¶
Vous pouvez trouver quelques documentations dans l'onglet "Documents" de chaque projet Redmine.
Ces documents peuvent être des contributions et ne sont pas toutes maintenues par l'équipe EOLE.
Contribuer à la documentation¶
Faire un signalement¶
Vous pouvez signaler des coquilles, faire des demandes d'amélioration ou d'ajout dans la documentation en vous rendant dans l'onglet "Demandes" du présent projet :
http://dev-eole.ac-dijon.fr/projects/documentations/issues
Proposer de la documentation¶
Vous pouvez proposer vos documentations, elles seront soient intégrées dans la documentation officielle ou mise à disposition dans l'onglet "Documents" du projet Redmine approprié.
Vous pouvez nous faire parvenir la documentation sur les listes ou à l'adresse de contact de l'équipe EOLE.
Pour les développeurs et les rédacteurs¶
Les bonnes pratiques¶
Rendre la doc la plus générique possible.
Évitez au maximum les numéros de version qui rendent les mises à jour monstrueuse.
La documentation se doit de respecter au mieux les conventions typographiques.
Vous pouvez retrouver celles-ci dans la documentation :
- directement dans SCENARI lorsque vous éditez la documentation
- en HTML à l'adresse http://eoleng.ac-dijon.fr/documentations/2.3/partielles/HTML/Documenter/
- en PDF à l'adresse http://eoleng.ac-dijon.fr/documentations/2.3/partielles/PDF/Documenter.pdf
Installation de ScenariClient¶
Il existe un tutos sur l'installation de ScenariClient accessible en interne sur le samba de l'équipe.
L'installation est également décrite dans la documentation.
Cycle de publication¶
Généralement une partie de la documentation est rédigée pendant la période de stabilisation des paquets, entre l'état candidat et l'état publié.
Lorsque les demandes sont passées à résolu elles nécessite une relecture par un tier pour ensuite être fermées.