Pérennité du site
Opened this issue · 5 comments
Bonjour à tous les contributeurs de ce repo.
Le portail a été initié par le BDE P10 (moi), puis a été repris par le BDE P11 pour devenir ce qu'il est maintenant (eleurent), et il est maintenant transféré au BDE P12.
Pour ceux qui n'étaient pas là, avant il y avait un ensemble de petits sites qui avaient fait par un P04, puis tous les ans des petits changements avaient été faits sans concertation générale. Ce qui fait que lorsque j'ai récupéré les sites, c'était impossible à développer, et bourré de failles (dont une qui permettait de récupérer les mdp du trombi).
J'ouvre ce ticket pour démarrer une réflexion afin de pérenniser le site. Il est important de ne pas permettre à n'importe qui de faire n'importe quoi, et d'avoir une certaine ligne de conduite de développement, sinon on va se retrouver dans quelques années dans la situation ci-dessus: personne ne comprendra un code global qui n'aura été que l'amoncellement de petits changements.
Je n'ai pas tellement de solution toute faite. Peut-être qu'on peut juste en discuter ici?
Tho
Bonne initiative Thomas.
Déjà on parlait de faire passer le portail en assoce (comme à l'X par exemple).
L'idée étant qu'il n'y aura pas forcément un geek motivé pour reprendre le projet chaque année dans la liste gagnante.
Le VP Geek serait éventuellement automatiquement le nouveau prez (a voir, mais même si c'est pas un gros geek, ça apporte des avantages et des responsabilités d'être au BDE).
Sinon j'ai commencé à essayer de faire une doc rapide en Latex, à l'attention du nouveau VP Geek. Faudrait peut être aussi faire un peu de refactoring pour que le code soit plus propre, et mieux commenté. Et même faire ça régulièrement.
Niveau architecture il y a un peu de travail à faire pour améliorer le tout, genre mettre les urls dans leurs apps respectives, virer certains modules devenus inutiles, etc.
@gcaner Tu as réfléchis à la question ?
Sinon pour la documentation j'ai perdu toutes les données de mon disque dur récemment donc je reprends à zero.
Du coup il y a deux options :
- un document LaTeX/PDF sur le repo git (donc modifiable par tous)
- un wiki
Je pense que le PDF est peut être plus facile à lire pour un nouveau VP Geekl, mais ça incitera peut être moins à contribuer, je ne sais pas...
Je te renvoie la documentation par mail que tu avais préparée (au mois de juillet). Je pensais à un simple fichier Word (que tu peux enregistrer en pdf si tu préfères, Acrobat XI te l'exporte sous Word) à déposer sur le git.
Je ne suis pas capable d'expliquer tout le code, mais ça n'est pas forcément utile de tout comprendre, ni de tout expliciter. Je pense que mon point de vue de débutant sur Django peut servir pour comprendre certaines choses au futur VP Geek.
Par contre il faudrait que l'on ne documente pas la même chose en même temps, que l'on sache ce que chacun fait.
Moi je préférais LaTeX à Word parce que c'est plus propre au niveau du code, et ça aiderait la gestion sur git notamment pour gérer les conflits, c'est trop le bordel le contenu d'un document word et on ne pourra pas merger sans écraser une version. LaTeX c'est bien facile, c'est un peu comme un fichier HTML donc pour git c'est l'idéal.
Sans compter que le rendu LaTeX en PDF est bien plus classe !
Mais bon là encore c'est juste une préférence personnelle hein, c'est toi le VP Geek donc c'est toi qui décides ;)
Ah oui je veux bien que tu me renvoies la version de juillet, mais bon ça me saoule j'avais fait plein de changements et d'ajouts cet été et j'ai tout perdu... Tant pis.
Je pense qu'un wiki sur github pourrait suffire, c'est du markdown (plus facile et plus propre que latex et aussi puissant pour ce genre de choses), et c'est basé sur git donc pas de problèmes de conflits. Si vous aimez pas que ce soit sur github seulement on peut mettre un dossier doc dans le repo-même avec les fichiers markdown puis avoir un script qui génère le html localement (beaucoup de projets open source font comme ça).