Skip to content

Documentation technique

Matti Schneider edited this page Oct 17, 2015 · 1 revision

Ce document a pour but de permettre l’intervention technique sur l’extension numérique de l’installation artistique Les quais, un site web accessible sur internet à l’adresse http://lesquais.voyage.

Aperçu

Le site web est un ensemble de fichiers statiques (HTML, CSS, JS et images). Ces fichiers sont générés par le moteur Jekyll à partir d’un ensemble de fichiers sources (plugins en Ruby, contenu en Markdown, CSS, JS et images haute résolution). Tous les outils sont libres. Le code lui-même étant également libre, l’hébergement tant du code source que du site généré est fourni gratuitement par la plateforme de collaboration GitHub. Le nom de domaine appartient à l’artiste Suzanne Hetzel.

Code source

Le code source à partir duquel le site statique peut être généré est libre (licence MIT). Le dépôt est accessible à l’adresse https://github.com/LesQuais/website. Il est possible de télécharger, cloner et modifier ce code sans autorisation préalable.

Ce dépôt contient également le contenu au format Markdown étendu par des balises Liquid, sous licence CC-BY-NC-SA.

Génération

Le moteur de génération du site statique à partir du contenu source est Jekyll. La procédure d’installation est décrite en détails sur le site jekyllrb.com. Les conventions de nommage des dossiers et de rédaction des plugins sont celles décrites par Jekyll, il faut donc commencer par se référer à sa documentation avant d’intervenir sur le code source.

La version minimale requise est la 2.1, et il est probable qu’une version majeure supérieure à la 2 soit incompatible, bien qu’aucune n’existe à l’heure de rédaction de ce document.

Hébergement

Le site statique généré par Jekyll à partir du code source est actuellement hébergé par la plateforme GitHub, sur un autre dépôt : https://github.com/LesQuais/lesquais.github.io. Le code étant libre, GitHub offre cet hébergement gratuitement.

Si ces conditions venaient à changer, il est possible de récupérer la dernière version du site statique directement sur ce dépôt, sans besoin d’installer Jekyll et de générer une nouvelle version statique du site web. Le site étant statique, il suffit de rendre accessible le contenu de ce dépôt sur n’importe quel serveur de fichiers pour en faire un miroir.

Mise à jour

La mise à jour du site se fait simplement en poussant une nouvelle version du site généré sur le dépôt lesquais.github.io. Pour effectuer une modification ponctuelle, ouvrez une Pull Request. Pour obtenir un droit d’accès récurrent, demandez à rejoindre l’organisation Les quais sur GitHub.

Nom de domaine

Le nom de domaine lesquais.voyage est réservé chez Gandi par Suzanne Hetzel, jusqu’au 17 juin 2019.

L’utilisation de l’hébergement GitHub pour ce nom de domaine se fait par une entrée A dans le registre DNS.

Contact

Si cette documentation technique n’était pas suffisante, contactez Matti Schneider.

Clone this wiki locally