CONTRIBUTING.md

Améliorer le site public de l'Incubateur

Ajouter une startup

En un clic par l'interface web de GitHub 😃

Sinon, offline : créer un nouveau fichier de description dans le dossier _startup et renseigner les informations en prenant exemple sur un fichier de description existant déjà dans ce dossier.

Éditer la description d'une startup

Modifier le fichier de description de la startup dans le dossier _startup.

Ajouter un événement

En un clic par l'interface web de GitHub 😃

Pour ajouter une image à l'événement, créer un fichier JPEG dans img/posts du même nom que le fichier contenant le post (donc par exemple AAAA-MM-DD-nom_evenement.jpg). À l'affichage, l'image sera redimensionnée : les dimensions exactes de l'image ont donc peu d'importance.

Sinon, offline : créer un nouveau post dans le dossier _posts et renseigner les informations en prenant exemple sur un événement existant déjà dans ce dossier. Le nom du fichier doit être au format AAAA-MM-DD-nom_evenement.md, où AAAA-MM-DD est la date à laquelle vous souhaitez que l'événement soit annoncé sur le site (et non la date de l'événement lui-même).

Modifier le contenu éditorial

Rechercher le contenu à modifier et éditer le fichier correspondant.

Modifier les startups mises en avant sur la page d'accueil

Mettre à jour la propriété featured de la phase correspondante pour référencer le nom du fichier dans lequel la startup à mettre en avant est décrite dans index.html.

Modifier la présentation du site

Ce site est construit avec Jekyll, un générateur de sites statiques. La version utilisée est celle actuellement en production sur GitHub Pages.

Pour l'améliorer, installer Ruby à la version indiquée ici et Jekyll par le biais de la gem github-pages :

git clone https://github.com/sgmap/beta.gouv.fr.git
cd beta.gouv.fr
gem install github-pages
jekyll serve

Les fichiers pertinents pour une modification de la présentation sont probablement dans les dossiers _layouts et css.

Modifier le logo

La source du logo est dans le répertoire _sources. Il s'agit d'un SVG contenant du texte. Pour le rendre accessible à tous les utilisateurs, il importe de le transformer en un SVG contenant des path.

Cela peut être fait à la ligne de commande avec Inkscape :

inkscape --export-text-to-path `pwd`/_sources/logo.svg -l `pwd`/logo-tmp.svg

Le fichier logo-tmp.svg doit ensuite être intégré dans _layouts/default.html. Il est conseillé de l'optimiser au préalable avec un outil comme svgo.

Le SVG est inclus en tant que nœud et non lié en tant que fichier pour des raisons de compatibilité cross-browser (IE≤11 n'est pas capable de le mettre à l'échelle autrement). Cela apporte également un léger gain de performance au premier chargement, compensé par la non-mise en cache du logo.

Déployer

Ce site est déployé en continu avec Github Pages. La branche principale, qui reflète la production, est donc gh-pages.

Pousser sur gh-pages, c’est partager avec le monde… ce qui signifie donc qu'il faut être très prudent avec ce pouvoir et privilégier l'usage de pull requests 😉

C'est pourquoi la branche gh-pages est protégée : il est impossible de mettre en production sans que les tests automatisés n'aient validé que le site pouvait être généré correctement.