Détails du modèle dans le wiki
Documentation du framework
Les supports peuvent être obtenus à ces adresses :
Version release : https://zen-formation-modele.appspot.com/
Version courante : https://master-dot-zen-formation-modele.appspot.com/
├── CahierExercices # Contient les enoncés des TP
│ ├── Cahier.md # Le fichier peut être découpé en autant de fichier que de TP
│ ├── parts.json # Contient la liste des fichiers des énoncés
│ ├── README.md # Explication détaillé de cette section
│ └── ressources # Contient les images utilisées dans les énoncés des TP
├── Exercices # Contient des starters dans TP ainsi que les corrections des TP
├── Installation # Contient les éléments logiciels à fournir aux stagaires
│ └── README.md # Explication détaillé de cette section
├── PLAN_en.md # Plan commercial en anglais (affiché sur le site public des formations)
├── PLAN.md # Plan commercial (affiché sur le site public des formations)
├── README.md # ce fichier (ne pas effacer son contenu)
├── REFERENCES.md # Références utiles pour donner ou préparer la formation (destiné aux formateurs)
├── run.sh # Permet lancer la formation avec Docker sous Linux ou Windows (Git Bash)
├── SessionsNotes # Contient l'ensemble des notes faites par les formateurs après chaque cession (organisation des TP, timing, ...)
│ └── README.md # Explication détaillé de cette section
└── Slides # Contient l'ensemble des slides
├── <num>_<slide>.md # Contenu des slides
├── ...
├── README.md # Explication détaillé de cette section
├── ressources # Contient les images et autres éléments utilisés dans les slides
└── slides.json # Contient la liste des fichiers des slides
Note : Chaque répertoire contient un fichier README.md
précisant son usage
Pour générer et afficher la formation, il est nécessaire d'avoir node
et npm
d'installé (voir node.js).
Installation de Node.js :
Exécuter la commande suivante :
npm install
Pour afficher les slides, exécuter la commande suivante :
grunt
Pour générer les .pdf
des slides :
grunt pdf
Si vous utiliser NPM3, utiliser la commande :
gulp
Pour ceux qui veulent se passer de l'installation de node
et npm
, il est possible d'utiliser Docker.
Installation de Docker :
- Linux : https://docs.docker.com/linux/step_one/
- Mac : https://docs.docker.com/mac/step_one/
- Windows : https://docs.docker.com/windows/step_one/
Lancer une des commandes suivantes :
./run.sh dev # pour afficher les slides
./run.sh prod # pour afficher la page de garde
./run.sh pdf # pour générer les `.pdf` des slides
./run.sh clean # pour terminer le conteneur Docker
Il est également possible de combiner les commandes :
./run.sh clean pdf prod
Afin de pouvoir éxécuter un script run.sh
, il faut disposer d'un émulateur de shell Unix-like : soit Git Bash (recommandé et fournit avec Git) soit Cygwin.
Alt + click
: zoom in, zoom outUp
,Down
,Left
,Right
: Navigationf
: Full-screens
: Show slide noteso
: Toggle overviewb
: Turn screen blackEsc
: Escape from full-screen, or toggle overview
https://github.com/hakimel/reveal.js/wiki/Keyboard-Shortcuts
En cas de problème lors de l'installation ou de l'utilisation, consultez la page dédié dans le wiki du Framework : Troubleshooting.
Chaque formation dispose d'une version web (disponible uniquement via un compte @zenika.com). Le mini-site de la formation contient les slides live, les slides PDF, le cahier d'exercice PDF, un lien vers le dépôt GitHub de la formation ainsi qu'un lien vers le catalogue de formation.
Ainsi il est important de bien remplir le fichier package.json
avec
name
: nom technique de la formation (sans espace)description
: le nom de la formation de la forme "Formation XXX"homepage
: le lien vers la page du catalogue correspondante (e.g. http://www.zenika.com/formation-angularjs.html)repository.url
: l'URL vers ce repositoryconfig.deploy.name
: l'id de l'instance AppEngine (faire une demande à [email protected])
2 branches sont automatiquement déployées sur AppEngine:
master
: il s'agit de la branche contenant les développements courants.- Elle est déployée sur
https://master-dot-{id AppEngine}.appspot.com
- Elle est déployée sur
release
: branche contenant la dernière version stable, utilisée en session de formation.- Elle est déployée sur
https://{id AppEngine}.appspot.com
- Elle est déployée sur
Le build et le déploiement sont réalisés par CircleCI.
À ce titre, un fichier circle.yml
est présent à la racine de ce projet.
Il n'y a à priori, aucune raison d'éditer ce fichier.