README.md 2.19 KB
Newer Older
Nicolas Guichard's avatar
Nicolas Guichard committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
# Le site internet d'Ensilibre

Vous avez trouvé le dépôt qui contient le code source du site internet
d'ensilibre. Ce site est basé sur [Hugo](https://gohugo.io/) et utilise le thème
[Terminal](https://themes.gohugo.io/hugo-theme-terminal/). Il est tenu à jour
grâce à GitLab Pages.

## GitLab Pages

À chaque modification de la branche `master`, GitLab clone le dépôt et le
compile à l'aide d'Hugo. Le résultat est alors publié par GitLab Pages sur
ensilibre.pages.ensimag.fr.

## Hugo

Voici les bases du fonctionnement d'Hugo requises pour pouvoir contribuer :
 * les pages sont générées à partir du dossier [`content`](content), 1 fichier = 1 page
 * les fichiers du dossier [`static`](static) sont servis tel quel
 * le fichier [`config.toml`](config.toml) décrit la configuration du site :
 titre, entrées du menu, …

Pour plus d'informations, consultez la [documentation officielle](https://gohugo.io/documentation/).

## Contribuer

Pour contribuer, plusieurs solutions.

En ligne ou sur votre propre machine. Vous pourrez prévisualiser vos changements si vous
clonez le projet sur votre machine.

### Proposer une idée de changement, reporter une erreur

Merci de passer par les [Issues](https://gitlab.ensimag.fr/ensilibre/ensilibre.pages.ensimag.fr/issues).

### Proposer un changement depuis l'éditeur en ligne

Directement depuis GitLab, sur la liste des fichier ou sur la vue d'une fichier, cliquez
sur Web IDE (ou traduction) en haut à droite. Si GitLab vous propose de forker le projet,
acceptez.

Effectuez vos modifications puis créez une Merge Request vers `master` depuis le menu à gauche.

### Proposer un changement depuis votre éditeur configuré aux petits oignons

Forkez ce dépôt, clonez votre fork sur votre machine et faîtes vos modifications. Si Hugo
est installé sur votre machine, vous pouvez voir vos modifications en direct dans votre
navigateur en lançant `hugo server` à la racine du dépôt.

**/!\ Vous devez faire un clone récursif du dépôt car le thème est inclus comme un
submodule git /!\\**

Poussez vos changements sur votre fork et créez une [Merge Request](https://gitlab.ensimag.fr/ensilibre/ensilibre.pages.ensimag.fr/merge_requests) vers `master` !