Skip to content

mrebiai/moijecodemadoc

Repository files navigation

Présentation "Moi je code m’ADOC"

Description du talk

La doc? Inutile, la vérité est dans le code! L’UML? Has-been si on est Agile! Mais en vrai, on doit écrire des specs, conceptions techniques, articles wiki, présentations…​ Et si on se passait d’Office, Rational Rose, Enterprise Architect, Visio, …​ Moi je code ma doc avec Asciidoctor et PlantUML. Retrouvons des fichiers plats, à mettre sous Git (version, historique, merge). Illustration sur de la "doc" d’une appli Web.

Plan de la présentation

  1. Illustration d’asciidoc, à travers l’écosystème asciidoctor

  2. Illustration de PlantUml, à travers la conception technique d’une application web

  3. Workflows de génération

Note
l’application web a été implémentée à partir d’une génération JBossForge, puis déployée sous JBoss EAP 6.4.

Récupération du backend revealjs

./download-backends.sh

Compilation

Compilation du projet + tests
mvn clean verify
Génération de la présentation avec le backend RevealJS (target/slides)
mvn -P slideRevealJS

Lancement des services

  • Pré-requis

    • docker

    • docker-compose

Lancement de gitlab et jenkins
docker-compose -f run-services.yml up

Configuration des services

Gitlab

  • Créer un groupe bdxio

  • Créer un projet mon-wiki dans ce groupe

Jenkins

  • Installer le workflow plugin

  • Créer un job de type workflow avec le fichier worklow.groovy

Gitlab + Jenkins

  • Ajouter un utilisateur jenkins dans gitlab

  • Autoriser cet utilisateur sur le projet mon-wiki

  • Créer un credential pour cet utilisateur dans Jenkins

Machine hôte

  • Tous les montages se font sous /srv

  • L’utilisateur jenkins du conteneur Jenkins doit avoir un accès en RW au fichier /var/run/docker.sock de la machine hôte.