Bienvenue jeune contributeur

Il existe plusieurs moyens de contribuer au projet.

  1. Faire des Issues(ticket) en d’emmerdant (Ajout/Correction/Modification)
  2. La seconde méthode plus ardue, mais plus généreuse consiste à donner et participer au code

Méthode Issue 1

Avant tout

Cette méthode est la plus feignante, elle consiste à déposer un Ticket sur la page du projet

Dans ce ticket, vous pouvez :

  • Demandez une correction orthographique
  • Demandez l’ajout d’une synthèse (Idéalement, donnez un fichier markdown/pdf ou autre document texte)
  • Proposez des améliorations quel que soit tout est le bienvenu.

Méthode Contribution 2

Prérequis

  • Un éditeur de texte de votre choix (VSCode, notepad)
  • GIT
  • HUGO

Pour l’éditeur de texte je vous laisse le choix, ce n’est qu’une question de goût

Debian/Ubuntu/Mint

  sudo apt install hugo

Arch linux

  sudo pacman -S hugo

Windows Ouvrez un terminal est tapé

  winget install Hugo.Hugo.Extended
winget install -e --id Git.Git
winget install -e --id GoLang.Go.1.18
winget install -e --id Gekorm.Dart

Créer un fork

Rendez-vous sur gitlab et chercher le projet maDoc (le lien vous y amène directement)

page gitlab

En haut à droite cliquez sur FORK

Vous devrez arriver sur cette page. À part le namespace vous n’avez rien besoin de changer page fork

Déployer en local

Une fois le fork créé, pensez bien à cloner le dépôt sur votre machine, la commande et la suivante

Exemple de commande

  git clone --recurse-submodules git@gitlab.siovhb.lycee-basch.fr:your.space/fork
  
  git branch nomDeVotreBranche
git switch nomDeVotreBranche
git push --set-upstream origin nomDeVotreBranche 
  
  git switch dev

Une fois clonée, ouvrez un terminal dans le dossier qui correspond à votre dépôt et tapez

  hugo server -D # Le tiret -D active les brouillons

Allez à l’adresse http://localhost:1313/

Modifier le projet BASE

Tous les contenus sont stockés dans /content/docs/

C’est écris en markdown par défaut un petit guide si besoin ici

si vous voulez créer une nouvelle page, il faut faire comme ceci

  hugo new docs/paPage.md

Si vous voulez créer plusieurs pages sur un même thème, il faut faire comme-suit

  hugo new docs/monTheme/_index.md
hugo new docs/paPage1.md
hugo new docs/paPage2.md

Pour le reste, vous pouvez soit regarder comment les autres, on fait ou vous référer à la doc officiel

Proposer votre travail

Pour proposer votre travail, il suffit de créer une merge request en allant sur le projet d’origine

Et de le redirigé sur le dépôt originel

Une vidéo exemple ci-dessous