Site Web BreizhCamp

Ce site Web est généré avec Hugo, A Fast and Modern Static Website Engine. La rapidité de génération est une des raisons du choix de cet excellent outil. Ce site est généré en quelques dizaines de millisecondes!

La majorité des contenus est écrit en Markdown ou sous forme de fichiers structurés YAML. Il est facile d'y contribuer directement depuis l'interface de GitHub.

Amis du BreizhCamp, n'hésitez pas à proposer des PR si vous voulez améliorer ce site!

Développement

A la racine se trouve un wrapper pour lancer Hugo, qui se chargera de télécharger le binaire Hugo s'il n'est pas disponible. Pour lancer localement le site:

./hugow.sh -w serve

puis accéder à http://localhost:1313. Hugo activera le rechargement automatique des pages modifiées. Etant donné la vitesse de génération, les modifications effectuées dans les sources sont visibles en quasi-temps réel dans le navigateur Web.

Passage à une nouvelle édition du breizhcamp

1. Edition précédente :
   1. Passer la méthode de récupération du programme en static
   2. (Mettre à jour le fichier des talks)
   3. (Archivez l'ancien site : inutile car il y a un repo git de déploiement par édition www-<year>)
2. Faire un tag de la version (ex : www-2017)
3. Créer le repo git de déploiement de la nouvelle édition (ex : www-2019)
   1. Créer le repo sur GitHub breizhcamp/www-AAAA
   2. Créer la branche gh-pages
   3. Créer le fichier CNAME contenant ceci :

      2019.breizhcamp.org
      
      

   4. Commiter ce fichier sur la branche gh-pages
   5. Pousser cette branche sur GitHub
   6. Activer GitHub Pages sur la branche gh-pages
4. Fichier config.toml, mettre à jour :
   • title
   • [params]
     • social_logo
   • [params.breizhcamp]
   • [[params.menu]] avec name = "Billetterie"
     • url
   • [params.features]
     • subtitle
5. Fichier build.sh, mettre à jour :
   • REPO dans le case -p|--prod
6. Passer les pages programme et speakers en draft
7. Passer la méthode de récupération du programme en cfp_api
8. Modifier le contenu du carousel data/carousel
9. Mettre à jour les pages du site, sponsors...
10. Bascule DNS
    1. sur le repo git de déploiement de l'édition précédente modifier le fichier CNAME pour mettre <year>.breizhcamp.org
    2. sur le repo git de déploiement de la nouvelle édition modifier le fichier CNAME pour mettre ceci :

       www.breizhcamp.org
       
       

Mise à jours des données

Liste des speakers

1. Dans le fichier bin/getSpeakers.groovy, remplacer __TODO_TOKEN__ par votre token d'authentification. NE FAITES PAS UN COMMIT DE CE FICHIER AVEC VOTRE TOCKEN DEDANS !
2. Lancer le script bin/update-json-speakers.sh
3. Faire un commit du fichier data/speakers.json

Liste des talks du programme

Si vous utilisez la méthode de récupération static pour récupérer les talks du programme, il faut mettre à jour le fichier static/json/talks.json :

1. Lancer le script bin/update-json-talks.sh
2. Faire un commit du fichier static/json/talks.json

Configuration

Récupération des talks pour le programme

Fichier config.toml, section params.breizhcamp, paramètre programme_get_talks_method :

• "cfp_api" : récupération via l'API du CFP
• "static" : récupération via le fichier static/json/talks.json (pensez à mettre à jour ce fichier !)

Organisation des branches

Ce dépot possède 2 branches, staging et production. La branche production doit être alimentée par des merges depuis la branche staging.

Déploiement

L'instance Jenkins du BreizhCamp permet de déployer automatiquement les branches principales de ce dépôt:

• la branche staging est déployée sur http://www-staging.breizhcamp.org
• la branche production est déployée sur http://www.breizhcamp.org

Les pages HTML générées sont servies par GitHub Pages et sont stockées dans:

• breizhcamp/www-staging pour la branche staging
• breizhcamp/www-<year> pour la branche production. (<year> est l'année de l'édition. Ex : breizhcamp/www-2018)

Les scripts de déploiement utilisé par l'intégration continue Jenkins sont dans le répertoire bin.

Dévelopment Web et Hugo

Quelques liens pour les non professionels du CSS et de Hugo

• http://cssreference.io/