Documentation de data.gouv.fr

Ce dépôt correspond au contenu du site doc.data.gouv.fr, site consacré à la documentation de la plateforme data.gouv.fr.

Contribuer

Les contributions sont les bienvenues. Elles peuvent prendre la forme de pull requests effectuées depuis un fork de ce dépôt, ou de discussions dans les tickets GitHub du dépôt.

Démarrage rapide

Ruby natif

Installer bundler :

gem install bundler

Compiler et démarrer un serveur de documentation :

git clone https://github.com/etalab/doc.data.gouv.fr
cd doc.data.gouv.fr
bundle install
bundle exec jekyll serve

La documentation apparaîtra alors à l’adresse suivante : http://localhost:4000.

Docker Compose

Vous pouvez utiliser docker-compose pour tester vos modifications localement avant de les soumettre. Pour ce faire, il suffit simplement d’exécuter la commande :

docker-compose up

Ceci va télécharger l'image docker de Jekyll et installer les dépendances nécessaires avant d'effectuer le rendu du site. Le résultat sera disponible sur http://localhost:4000. Les modifications sont automatiquement prises en compte et provoquent un nouveau rendu du site.