LISEZ-MOI.md

Le but de cette section est de définir des lignes directrices dans la contribution au site, ainsi qu'informer sur la philosophie général de l'outil. Le lien vers le dépôt est acessible ici

Principes

Le code source du site est libre d'accès, et nous sommes tous collaborateurs du dépot Github du projet, ce qui veut dire que nous avons tous les mêmes droits d'édition sur le site. Techniquement, nous pouvons donc en faire n'importe quoi sans modération.

Le but est ainsi de proposer un support d'aide au cours tout en permettant d'expérimenter avec des technologies web et git, de façon à permettre à chacun de s'entrainer un peu.

Bien entendu, le but n'est pas d'en faire un répertoire de mêmes ou un forum de discussions. De ce fait, nous allons définir quelques bonnes pratiques dans contribution à ce site. Elles peuvent bien sur changer, puisque même cette page peut être éditée par tout le monde.

Le site est spécifique à cette promotion, et nous appartient à tous.

Editer le site : les bases

L'idée est la suivante: on clone le projet, on regarde les sources, on essaie de deviner comment le site fonctionne, et une fois les changements opérés, on push sur le dépot github, qui a un script de déploiement automatique sur Github pages.

Structure technique du projet

Le projet est basé sur l'outil docusaurus, une solution proposée par facebook permettant de déployer facilement un site de documentation, comprenant une partie documents et une partie blog.

Le projet est basé sur nodeJs, comprend des composants React, et contient des pages au format markdown et non HTML.

Si vous souhaitez apprendre à utiliser en profondeur le site, vous pouvez visiter ce lien proposant un petit tutoriel pour apprendre à utiliser Docusaurus

Proposition de démarche à suivre pour la contribution

Techniquement, nous pouvons faire n'importe quoi de ce site, mais voici quelques propositions de démarches à suivre pour que cela ne devienne pas justement n'importe quoi:

• Commencez par cloner le dépôt en local, et ne faites pas de modification directement depuis Github
• Créer une nouvelle branche du nom de l'ajout que vous souhaitez faire au site. Si vous souhaitez corriger un post déjà existant, créez une branche sous un format similaire à correction : <nom_document>
• Une fois les changements opérés, pushez sur le dépot distant, et faites une pull request de votre branche vers main, en mettant en reviewer les gens que vous souhaitez voir confirmer la qualité de ce que vous avez produit.

Cela permettra d'éviter d'avoir des informations non relues et donc plus probablement incorrectes sur ce site devant servir à l'entraide.

Propositions de contenu

Ici, nous proposons de scinder le site en deux parties:

• La première concernerait les cours proposés par Diginamic, et reprendrait la structure des cours de la formation. On pourrait alors poster dans les différentes du contenu en rapport avec le cours, comme des propositions de correction pour des exercices, des reformulations du cours, des approfondissemnts
• La seconde serait une partie blog un peu plus libre, ou chacun pourrait poster le contenu qu'il souhaite, si possible en lien avec l'informatique. Cela permettrait à chacun de partager un peu de ses connaissances dans le domaine. On pourrait également imaginer que chacun puisse partager ses projets personnels, ses trouvailles sur youtube, etc. Cette partie serait beaucoup plus libre et informelle.